# AzureFile Class The AzureFile class provides an easy to use interface to Microsoft's Azure File Storage service. ## Syntax **cloudstorage.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](#azurefileaccount-property) property to the name of the Azure Storage account to operate against, and set the [AccessKey](#azurefileaccesskey-property) 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](#azurefilelistshares-method) method to list available shares, and select which one the class should operate against using the [Share](#azurefileshare-property) 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](#azurefilelistresources-method) lists resources (files and folders) within the specified directory. Calling this method will fire the [ResourceList](#azurefileresourcelist-event) event once for each resource, and will also populate the [Resources](#azurefileresources-property) collection. ```text // 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](#azurefiledownloadfile-method) method downloads files. If [LocalFile](#azurefilelocalfile-property) is set, the file will be saved to the specified location; otherwise, the file data will be held by [ResourceData](#azurefileresourcedata-property). To download and decrypt an encrypted file, set [EncryptionAlgorithm](#azurefileencryptionalgorithm-property) and [EncryptionPassword](#azurefileencryptionpassword-property) before calling this method. ### Download Notes In the simplest use-case, downloading a file looks like this: ```text azurefile.LocalFile = "../MyFile.zip"; azurefile.DownloadFile(azurefile.Resources[0].Path); ``` **Resuming Downloads** The class also supports resuming failed downloads by using the [StartByte](#azurefilestartbyte-property) property. If a download is interrupted, set [StartByte](#azurefilestartbyte-property) to the appropriate offset before calling this method to resume the download. ```text 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](#azurefilelocalfile-property) was set in the initial download attempt. If [LocalFile](#azurefilelocalfile-property) is set when beginning an encrypted download, the class creates a temporary file in [TempPath](#TempPath) to hold the encrypted data until the download is complete. If the download is interrupted, [DownloadTempFile](#DownloadTempFile) will be populated with the path of the temporary file that holds the partial data. To resume, [DownloadTempFile](#DownloadTempFile) must be populated, along with [StartByte](#azurefilestartbyte-property), 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](#azurefilelocalfile-property). ```text 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](#azurefileuploadfile-method) method uploads new files. If [LocalFile](#azurefilelocalfile-property) is set the file will be uploaded from the specified path. If [LocalFile](#azurefilelocalfile-property) is not set the data in [ResourceData](#azurefileresourcedata-property) will be used. To encrypt the file before uploading it, set [EncryptionAlgorithm](#azurefileencryptionalgorithm-property) and [EncryptionPassword](#azurefileencryptionpassword-property). ### Upload Notes The [UploadFile](#azurefileuploadfile-method) method is a convenience method that performs a resumable file upload. When called, the class first uses [CreateFile](#azurefilecreatefile-method) to initialize a new file entry on the server; and then it fragments the file data into smaller pieces and calls [PutRange](#azurefileputrange-method) 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](#azurefilefragmentcomplete-event) event fires after each fragment is uploaded to indicate overall progress. The class also updates [StartByte](#azurefilestartbyte-property) 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](#azurefilestartbyte-property) 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](#azurefileuploadfile-method) again to resume the upload at the specified [StartByte](#azurefilestartbyte-property) offset. ```text azurefile.LocalFile = "../MyFile.zip"; azurefile.UploadFile("MyFile.zip"); //The transfer is interrupted and UploadFile() above fails. Later, resume the upload. //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: - Encrypt and decrypt files using the [EncryptionAlgorithm](#azurefileencryptionalgorithm-property) and [EncryptionPassword](#azurefileencryptionpassword-property) properties. - Basic file and folder manipulation and organization using methods such as [CreateFolder](#azurefilecreatefolder-method), [CopyFile](#azurefilecopyfile-method), [DeleteFolder](#azurefiledeletefolder-method), and [DeleteFile](#azurefiledeletefile-method). - Advanced file manipulation with [CreateFile](#azurefilecreatefile-method), [ResizeFile](#azurefileresizefile-method), [PutRange](#azurefileputrange-method), GetRanges, and [ClearRange](#azurefileclearrange-method). - Share manipulation with [CreateShare](#azurefilecreateshare-method), [SetShareQuota](#azurefilesetsharequota-method), and [DeleteShare](#azurefiledeleteshare-method). - Retrieval of information and metadata for files, folders, and shares using [GetFileInfo](#azurefilegetfileinfo-method), [GetFolderInfo](#azurefilegetfolderinfo-method), and [GetShareInfo](#azurefilegetshareinfo-method). - And more! ## 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](#azurefileaccesskey-property) | The Azure access key to use for authentication. | | [Account](#azurefileaccount-property) | The Azure storage account name. | | [Authorization](#azurefileauthorization-property) | The OAuth 2.0 authorization token. | | [EncryptionAlgorithm](#azurefileencryptionalgorithm-property) | The encryption algorithm. | | [EncryptionPassword](#azurefileencryptionpassword-property) | The encryption password. | | [Firewall](#azurefilefirewall-property) | A set of properties related to firewall access. | | [Idle](#azurefileidle-property) | The current status of the class. | | [LocalFile](#azurefilelocalfile-property) | The location of the local file. | | [LocalHost](#azurefilelocalhost-property) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [Metadata](#azurefilemetadata-property) | A collection of metadata items. | | [OAuth](#azurefileoauth-property) | The OAuth settings. | | [OtherHeaders](#azurefileotherheaders-property) | Other headers as determined by the user (optional). | | [Overwrite](#azurefileoverwrite-property) | Determines if files are overwritten. | | [ParsedHeaders](#azurefileparsedheaders-property) | This property includes a collection of headers returned from the last request. | | [Prefix](#azurefileprefix-property) | A prefix used to restrict the results returned when listing resources or shares. | | [Proxy](#azurefileproxy-property) | A set of properties related to proxy access. | | [QueryParams](#azurefilequeryparams-property) | Additional query parameters to be included in the request. | | [Ranges](#azurefileranges-property) | A collection of byte ranges. | | [ResourceData](#azurefileresourcedata-property) | The data that was downloaded, or that should be uploaded. | | [ResourceMarker](#azurefileresourcemarker-property) | A marker indicating what page of resources to return next. | | [Resources](#azurefileresources-property) | A collection of resources. | | [Share](#azurefileshare-property) | Selects a share. | | [ShareMarker](#azurefilesharemarker-property) | A marker indicating what page of shares to return next. | | [Shares](#azurefileshares-property) | A collection of shares. | | [SSLAcceptServerCert](#azurefilesslacceptservercert-property) | Instructs the class to unconditionally accept the server certificate that matches the supplied certificate. | | [SSLCert](#azurefilesslcert-property) | The certificate to be used during Secure Sockets Layer (SSL) negotiation. | | [SSLProvider](#azurefilesslprovider-property) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. | | [SSLServerCert](#azurefilesslservercert-property) | The server certificate for the last established connection. | | [StartByte](#azurefilestartbyte-property) | The byte offset from which to start the upload or download. | | [Timeout](#azurefiletimeout-property) | The timeout for the class. | | [UseSSL](#azurefileusessl-property) | 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](#azurefileabortcopy-method) | Aborts a copy operation. | | [AddMetadata](#azurefileaddmetadata-method) | Adds a metadata item to the Metadata properties. | | [AddQueryParam](#azurefileaddqueryparam-method) | Adds a query parameter to the QueryParams properties. | | [Authorize](#azurefileauthorize-method) | Get the authorization string required to access the protected resource. | | [ClearRange](#azurefileclearrange-method) | Clears a range of bytes from a file. | | [Config](#azurefileconfig-method) | Sets or retrieves a configuration setting. | | [CopyFile](#azurefilecopyfile-method) | Copies a file. | | [CreateFile](#azurefilecreatefile-method) | Initializes a new file. | | [CreateFolder](#azurefilecreatefolder-method) | Creates a new folder. | | [CreateShare](#azurefilecreateshare-method) | Creates a new share. | | [DeleteFile](#azurefiledeletefile-method) | Deletes a file. | | [DeleteFolder](#azurefiledeletefolder-method) | Deletes a folder. | | [DeleteShare](#azurefiledeleteshare-method) | Deletes a share. | | [DownloadFile](#azurefiledownloadfile-method) | Downloads a file. | | [GetFileInfo](#azurefilegetfileinfo-method) | Gets a file's information and metadata. | | [GetFolderInfo](#azurefilegetfolderinfo-method) | Gets a folder's information and metadata. | | [GetLink](#azurefilegetlink-method) | Creates a link that provides access to a share or file. | | [ListRanges](#azurefilelistranges-method) | Gets the list of allocated data ranges in a file. | | [GetShareInfo](#azurefilegetshareinfo-method) | Gets a share's information and metadata. | | [Interrupt](#azurefileinterrupt-method) | This method interrupts the current method. | | [ListResources](#azurefilelistresources-method) | Lists resources in a given folder. | | [ListShares](#azurefilelistshares-method) | Lists shares in the file storage account. | | [PutRange](#azurefileputrange-method) | Uploads a range of data to a file. | | [RenameFile](#azurefilerenamefile-method) | Renames a file. | | [RenameFolder](#azurefilerenamefolder-method) | Renames a directory. | | [Reset](#azurefilereset-method) | Resets the class to its initial state. | | [ResizeFile](#azurefileresizefile-method) | Resizes a file. | | [SetDownloadStream](#azurefilesetdownloadstream-method) | Sets the stream to which downloaded data will be written. | | [SetShareQuota](#azurefilesetsharequota-method) | Sets a share's space quota. | | [SetUploadStream](#azurefilesetuploadstream-method) | Sets the stream from which data is read when uploading. | | [UpdateMetadata](#azurefileupdatemetadata-method) | Sets the metadata for a file, folder, or share. | | [UploadFile](#azurefileuploadfile-method) | Uploads 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.* | | | | --- | --- | | [EndTransfer](#azurefileendtransfer-event) | Fired when a document finishes transferring. | | [Error](#azurefileerror-event) | Fired when information is available about errors during data delivery. | | [FragmentComplete](#azurefilefragmentcomplete-event) | Fires after each fragment of a resumable upload is completed. | | [Header](#azurefileheader-event) | Fired every time a header line comes in. | | [Log](#azurefilelog-event) | Fired once for each log message. | | [Progress](#azurefileprogress-event) | Fires during an upload or download to indicate transfer progress. | | [ResourceList](#azurefileresourcelist-event) | Fires once for each resource returned when listing resources. | | [ShareList](#azurefilesharelist-event) | Fires once for each share returned when listing shares. | | [SSLServerAuthentication](#azurefilesslserverauthentication-event) | Fired after the server presents its certificate to the client. | | [SSLStatus](#azurefilesslstatus-event) | Fired when secure connection progress messages are available. | | [StartTransfer](#azurefilestarttransfer-event) | Fired when a document starts transferring (after the headers). | | [Transfer](#azurefiletransfer-event) | Fired while a document transfers (delivers document). | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AccumulatePages](#AccumulatePages) | Whether the class should accumulate subsequent pages of results when listing them. | | [APIVersion](#APIVersion) | The Azure Storage REST API version being used by the class. | | [CopyId](#CopyId) | The Id of a copy operation. | | [CopyProgress](#CopyProgress) | The progress of a copy operation. | | [CopyStatus](#CopyStatus) | The status of a copy operation. | | [CopyStatusDesc](#CopyStatusDesc) | The status description for a copy operation. | | [CreateShareQuota](#CreateShareQuota) | Specifies an initial space quota to impose when creating shares. | | [DeleteShareSnapshots](#DeleteShareSnapshots) | Whether to automatically delete share snapshots when deleting a share. | | [DownloadTempFile](#DownloadTempFile) | The temporary file used when downloading encrypted data. | | [EncryptionIV](#EncryptionIV) | The initialization vector to be used for encryption/decryption. | | [EncryptionKey](#EncryptionKey) | The key to use during encryption/decryption. | | [EncryptionPasswordKDF](#EncryptionPasswordKDF) | The KDF algorithm to use during password based encryption and decryption. | | [Endpoint](#Endpoint) | The Azure Storage endpoint suffix that the class should use. | | [MaxResults](#MaxResults) | The maximum number of results to return when listing resources or shares. | | [ProgressAbsolute](#ProgressAbsolute) | Whether the class should track transfer progress absolutely. | | [ProgressStep](#ProgressStep) | How often the progress event should be fired, in terms of percentage. | | [RawRequest](#RawRequest) | Returns the data that was sent to the server. | | [RawResponse](#RawResponse) | Returns the data that was received from the server. | | [SendMetadata](#SendMetadata) | Whether to send metadata items when creating files and folders. | | [SendMetadataOnCopy](#SendMetadataOnCopy) | Whether to send metadata items when copying files. | | [SharedAccessSignature](#SharedAccessSignature) | Specifies a SAS token to use for authentication. | | [TempPath](#TempPath) | The path to the directory where temporary files are created. | | [XChildCount](#XChildCount) | The number of child elements of the current element. | | [XChildName\[i\]](#XChildName[i]) | The name of the child element. | | [XChildXText\[i\]](#XChildXText[i]) | The inner text of the child element. | | [XElement](#XElement) | The name of the current element. | | [XParent](#XParent) | The parent of the current element. | | [XPath](#XPath) | Provides a way to point to a specific element in the returned XML or JSON response. | | [XSubTree](#XSubTree) | A snapshot of the current element in the document. | | [XText](#XText) | The text of the current element. | | [AcceptEncoding](#AcceptEncoding) | Used to tell the server which types of content encodings the client supports. | | [AllowHTTPCompression](#AllowHTTPCompression) | This property enables HTTP compression for receiving data. | | [AllowHTTPFallback](#AllowHTTPFallback) | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. | | [Append](#Append) | Whether to append data to LocalFile. | | [Authorization](#Authorization) | The Authorization string to be sent to the server. | | [BytesTransferred](#BytesTransferred) | Contains the number of bytes transferred in the response data. | | [ChunkSize](#ChunkSize) | Specifies the chunk size in bytes when using chunked encoding. | | [CompressHTTPRequest](#CompressHTTPRequest) | Set to true to compress the body of a PUT or POST request. | | [EncodeURL](#EncodeURL) | If set to True the URL will be encoded by the class. | | [FollowRedirects](#FollowRedirects) | Determines what happens when the server issues a redirect. | | [GetOn302Redirect](#GetOn302Redirect) | If set to True the class will perform a GET on the new location. | | [HTTP2HeadersWithoutIndexing](#HTTP2HeadersWithoutIndexing) | HTTP2 headers that should not update the dynamic header table with incremental indexing. | | [HTTPVersion](#HTTPVersion) | The version of HTTP used by the class. | | [IfModifiedSince](#IfModifiedSince) | A date determining the maximum age of the desired document. | | [KeepAlive](#KeepAlive) | Determines whether the HTTP connection is closed after completion of the request. | | [KerberosSPN](#KerberosSPN) | The Service Principal Name for the Kerberos Domain Controller. | | [LogLevel](#LogLevel) | The level of detail that is logged. | | [MaxRedirectAttempts](#MaxRedirectAttempts) | Limits the number of redirects that are followed in a request. | | [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) | The negotiated HTTP version. | | [OtherHeaders](#OtherHeaders) | Other headers as determined by the user (optional). | | [ProxyAuthorization](#ProxyAuthorization) | The authorization string to be sent to the proxy server. | | [ProxyAuthScheme](#ProxyAuthScheme) | The authorization scheme to be used for the proxy. | | [ProxyPassword](#ProxyPassword) | A password if authentication is to be used for the proxy. | | [ProxyPort](#ProxyPort) | Port for the proxy server (default 80). | | [ProxyServer](#ProxyServer) | Name or IP address of a proxy server (optional). | | [ProxyUser](#ProxyUser) | A user name if authentication is to be used for the proxy. | | [SentHeaders](#SentHeaders) | The full set of headers as sent by the client. | | [StatusCode](#StatusCode) | The status code of the last response from the server. | | [StatusLine](#StatusLine) | The first line of the last response from the server. | | [TransferredData](#TransferredData) | The contents of the last response from the server. | | [TransferredDataLimit](#TransferredDataLimit) | The maximum number of incoming bytes to be stored by the class. | | [TransferredHeaders](#TransferredHeaders) | The full set of headers as received from the server. | | [TransferredRequest](#TransferredRequest) | The full request as sent by the client. | | [UseChunkedEncoding](#UseChunkedEncoding) | Enables or Disables HTTP chunked encoding for transfers. | | [UseIDNs](#UseIDNs) | Whether to encode hostnames to internationalized domain names. | | [UseProxyAutoConfigURL](#UseProxyAutoConfigURL) | Whether to use a Proxy auto-config file when attempting a connection. | | [UserAgent](#UserAgent) | Information about the user agent (browser). | | [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. | | [FirewallAutoDetect](#FirewallAutoDetect) | Tells the class whether or not to automatically detect and use firewall system settings, if available. | | [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). | | [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. | | [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. | | [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. | | [FirewallType](#FirewallType) | Determines the type of firewall to connect through. | | [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. | | [Linger](#Linger) | When set to True, connections are terminated gracefully. | | [LingerTime](#LingerTime) | Time in seconds to have the connection linger. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the class binds. | | [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. | | [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. | | [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. | | [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. | | [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. | | [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. | | [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. | | [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. | | [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). | | [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. | | [SSLAcceptAnyServerCert](#SSLAcceptAnyServerCert) | Whether to trust any certificate presented by the server. | | [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. | | [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. | | [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. | | [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. | | [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. | | [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. | | [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. | | [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. | | [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. | | [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. | | [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. | | [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. | | [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. | | [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. | | [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. | | [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. | | [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. | | [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. | | [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. | | [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. | | [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. | | [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. | | [FirewallData](#FirewallData) | Used to send extra data to the firewall. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # [AzureFile](#azurefile-class).AccessKey Property The Azure access key to use for authentication. ## Syntax ```text getAccessKey(): string; setAccessKey(accessKey: string): void; ``` ## Default Value "" ## Remarks This property specifies the Azure access key that should be used for authentication. It must be set before attempting any operations which connect to the server. Both primary and secondary access keys are valid. This property is not available at design time. # [AzureFile](#azurefile-class).Account Property The Azure storage account name. ## Syntax ```text getAccount(): string; setAccount(account: string): void; ``` ## Default Value "" ## Remarks This property specifies the name of the Azure storage account to operate against. It must be set before attempting any operations which connect to the server. This property is not available at design time. # [AzureFile](#azurefile-class).Authorization Property The OAuth 2.0 authorization token. ## Syntax ```text getAuthorization(): string; setAuthorization(authorization: string): void; ``` ## Default Value "" ## Remarks This property is used to specify the OAuth 2.0 authorization token that was obtained as a result of performing OAuth. A valid OAuth token will come in the following format: ```text Bearer ACCESS_TOKEN ``` The *ACCESS_TOKEN* segment must be supplied to this property before attempting any other operations. Consult the documentation for the service for more information about supported scope values and more details on performing OAuth. # [AzureFile](#azurefile-class).EncryptionAlgorithm Property The encryption algorithm. ## Syntax ```text getEncryptionAlgorithm(): AzureFileEncryptionAlgorithms; setEncryptionAlgorithm(encryptionAlgorithm: AzureFileEncryptionAlgorithms): void; enum AzureFileEncryptionAlgorithms { eaAES, eaBlowfish, eaCAST, eaDES, eaIDEA, eaRC2, eaRC4, eaTEA, eaTripleDES, eaTwofish, eaRijndael, eaChaCha, eaXSalsa20 } ``` ## Default Value 0 ## Remarks This property specifies the encryption algorithm to be used. The maximum allowable key size is automatically used for the selected algorithm. Possible values are: | Algorithm | Key Size | | --- | --- | | 0 (eaAES - default) | 256 | | 1 (eaBlowfish) | 448 | | 2 (eaCAST) | 128 | | 3 (eaDES) | 64 | | 4 (eaIDEA) | 128 | | 5 (eaRC2) | 128 | | 6 (eaRC4) | 2048 | | 7 (eaTEA) | 128 | | 8 (eaTripleDES) | 192 | | 9 (eaTwofish) | 256 | | 10 (eaRijndael) | 256 | | 11 (eaChaCha) | 256 | | 12 (eaXSalsa20) | 256 | # [AzureFile](#azurefile-class).EncryptionPassword Property The encryption password. ## Syntax ```text getEncryptionPassword(): string; setEncryptionPassword(encryptionPassword: string): void; ``` ## Default Value "" ## Remarks If this property is populated when [UploadFile](#azurefileuploadfile-method) or [DownloadFile](#azurefiledownloadfile-method) is called, the class will attempt to encrypt or decrypt the data before uploading or after downloading it. The class uses the value specified here to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly. However, it is also possible to explicitly specify the Key and IV values to use by setting the [EncryptionKey](#EncryptionKey) and [EncryptionIV](#EncryptionIV) configuration settings. This may be necessary if, e.g., the data needs to be encrypted/decrypted by another utility which generates Key and IV values differently. This property is not available at design time. # [AzureFile](#azurefile-class).Firewall Property A set of properties related to firewall access. ## Syntax ```text getFirewall(): Firewall; setFirewall(firewall: Firewall): void; ``` ## Default Value ## Remarks This is a [Firewall](#firewall-type)-type property, which contains fields describing the firewall through which the class will attempt to connect. Please refer to the [Firewall](#firewall-type) type for a complete list of fields. # [AzureFile](#azurefile-class).Idle Property The current status of the class. ## Syntax ```text isIdle(): boolean; ``` ## Default Value TRUE ## Remarks This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times. This property is read-only. # [AzureFile](#azurefile-class).LocalFile Property The location of the local file. ## Syntax ```text getLocalFile(): string; setLocalFile(localFile: string): void; ``` ## Default Value "" ## Remarks This property specifies the location of a file on disk. This is used as the source file when calling [UploadFile](#azurefileuploadfile-method) or [PutRange](#azurefileputrange-method), and as the destination file when calling [DownloadFile](#azurefiledownloadfile-method). # [AzureFile](#azurefile-class).LocalHost Property The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax ```text getLocalHost(): string; setLocalHost(localHost: string): void; ``` ## Default Value "" ## Remarks This property contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used. If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window. # [AzureFile](#azurefile-class).Metadata Property A collection of metadata items. ## Syntax ```text getMetadata(): AzureMetadataList; ``` ## Default Value ## Remarks This collection holds a list of metadata items. This collection is populated anytime one of [GetFileInfo](#azurefilegetfileinfo-method), [GetFolderInfo](#azurefilegetfolderinfo-method), or [GetShareInfo](#azurefilegetshareinfo-method) is called. The items in this collection may be used by some of the following methods: [UpdateMetadata](#azurefileupdatemetadata-method), [UploadFile](#azurefileuploadfile-method), [CreateFile](#azurefilecreatefile-method), [CopyFile](#azurefilecopyfile-method), and [CreateFolder](#azurefilecreatefolder-method). This property is not available at design time. Please refer to the [AzureMetadata](#azuremetadata-type) type for a complete list of fields. # [AzureFile](#azurefile-class).OAuth Property The OAuth settings. ## Syntax ```text getOAuth(): OAuthSettings; ``` ## Default Value ## Remarks This property is used to configure the necessary fields to authenticate with the service provider. See the introduction for more information. This property is read-only and not available at design time. Please refer to the [OAuthSettings](#oauthsettings-type) type for a complete list of fields. # [AzureFile](#azurefile-class).OtherHeaders Property Other headers as determined by the user (optional). ## Syntax ```text getOtherHeaders(): string; setOtherHeaders(otherHeaders: string): void; ``` ## Default Value "" ## Remarks This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From. The headers must follow the format *Header: Value* as described in the HTTP specifications. Header lines should be separated by . Use this property with caution. If this property contains invalid headers, HTTP requests may fail. This property is useful for extending the functionality of the class beyond what is provided. This property is not available at design time. # [AzureFile](#azurefile-class).Overwrite Property Determines if files are overwritten. ## Syntax ```text isOverwrite(): boolean; setOverwrite(overwrite: boolean): void; ``` ## Default Value FALSE ## Remarks This property controls whether local files are overwritten when calling [DownloadFile](#azurefiledownloadfile-method) or remote files are renamed when calling [RenameFile](#azurefilerenamefile-method). The default value is *false*. # [AzureFile](#azurefile-class).ParsedHeaders Property This property includes a collection of headers returned from the last request. ## Syntax ```text getParsedHeaders(): HeaderList; ``` ## Default Value ## Remarks This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each [Header](#header-type) in this collection contains information describing that header. [MaxHeaders](#MaxHeaders) can be used to control the maximum number of headers saved. This property is read-only and not available at design time. Please refer to the [Header](#header-type) type for a complete list of fields. # [AzureFile](#azurefile-class).Prefix Property A prefix used to restrict the results returned when listing resources or shares. ## Syntax ```text getPrefix(): string; setPrefix(prefix: string): void; ``` ## Default Value "" ## Remarks This property, if non-empty, is used to restrict the results returned by [ListResources](#azurefilelistresources-method) or [ListShares](#azurefilelistshares-method) to only the items whose names begin with the given value. This property is not available at design time. # [AzureFile](#azurefile-class).Proxy Property A set of properties related to proxy access. ## Syntax ```text getProxy(): Proxy; setProxy(proxy: Proxy): void; ``` ## Default Value ## Remarks This property contains fields describing the proxy through which the class will attempt to connect. Please refer to the [Proxy](#proxy-type) type for a complete list of fields. # [AzureFile](#azurefile-class).QueryParams Property Additional query parameters to be included in the request. ## Syntax ```text getQueryParams(): QueryParamList; ``` ## Default Value ## Remarks This is a collection of query parameters that will be added to the request. Parameters can be added via the [AddQueryParam](#azurefileaddqueryparam-method) method. Please refer to the [QueryParam](#queryparam-type) type for a complete list of fields. # [AzureFile](#azurefile-class).Ranges Property A collection of byte ranges. ## Syntax ```text getRanges(): AzureRangeList; ``` ## Default Value ## Remarks This collection holds a list of byte ranges. Calling GetRanges will populate this collection. This property is read-only and not available at design time. Please refer to the [AzureRange](#azurerange-type) type for a complete list of fields. # [AzureFile](#azurefile-class).ResourceData Property The data that was downloaded, or that should be uploaded. ## Syntax ```text getResourceData(): Uint8Array; setResourceData(resourceData: Uint8Array): void; ``` ## Default Value "" ## Remarks This property is populated with file data after calling [DownloadFile](#azurefiledownloadfile-method) if [LocalFile](#azurefilelocalfile-property) is not set. This property can also be set before calling [UploadFile](#azurefileuploadfile-method); its data will be uploaded if [LocalFile](#azurefilelocalfile-property) is not set. This property is not available at design time. # [AzureFile](#azurefile-class).ResourceMarker Property A marker indicating what page of resources to return next. ## Syntax ```text getResourceMarker(): string; setResourceMarker(resourceMarker: string): void; ``` ## Default Value "" ## Remarks This property will be populated when [ListResources](#azurefilelistresources-method) is called if the results are paged and there are more pages. To list all resources, continue to call [ListResources](#azurefilelistresources-method) until this property returns empty string. Refer to [ListResources](#azurefilelistresources-method) for more information. This property is not available at design time. # [AzureFile](#azurefile-class).Resources Property A collection of resources. ## Syntax ```text getResources(): AzureFileResourceList; ``` ## Default Value ## Remarks This collection holds a list of file and folder resources. Calling [ListResources](#azurefilelistresources-method) or GetResourceInfo will populate this collection. This property is read-only and not available at design time. Please refer to the [AzureFileResource](#azurefileresource-type) type for a complete list of fields. # [AzureFile](#azurefile-class).Share Property Selects a share. ## Syntax ```text getShare(): string; setShare(share: string): void; ``` ## Default Value "" ## Remarks This property selects a share, by name, for the class to operate against. It must be set before attempting most operations. ### Share Name Rules Share names must adhere to the following rules: - Must be 3 to 63 characters long. - Must start with a letter or number; and may only contain letters, numbers, and hyphens. - All letters much be lowercase. (For convenience, the class will automatically lowercase all letters in any value assigned to Share.) - All hyphens must be immediately preceded *and* followed by a letter or number (consecutive hyphens are not allowed). This property is not available at design time. # [AzureFile](#azurefile-class).ShareMarker Property A marker indicating what page of shares to return next. ## Syntax ```text getShareMarker(): string; setShareMarker(shareMarker: string): void; ``` ## Default Value "" ## Remarks This property will be populated when [ListShares](#azurefilelistshares-method) is called if the results are paged and there are more pages. To list all shares, continue to call [ListShares](#azurefilelistshares-method) until this property returns empty string. Refer to [ListShares](#azurefilelistshares-method) for more information. This property is not available at design time. # [AzureFile](#azurefile-class).Shares Property A collection of shares. ## Syntax ```text getShares(): AzureFileShareList; ``` ## Default Value ## Remarks This collection holds a list of shares. Calling [ListShares](#azurefilelistshares-method) or [GetShareInfo](#azurefilegetshareinfo-method) will populate this collection. This property is read-only and not available at design time. Please refer to the [AzureFileShare](#azurefileshare-type) type for a complete list of fields. # [AzureFile](#azurefile-class).SSLAcceptServerCert Property Instructs the class to unconditionally accept the server certificate that matches the supplied certificate. ## Syntax ```text getSSLAcceptServerCert(): Certificate; setSSLAcceptServerCert(SSLAcceptServerCert: Certificate): void; ``` ## Default Value ## Remarks If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error. You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally. NOTE: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # [AzureFile](#azurefile-class).SSLCert Property The certificate to be used during Secure Sockets Layer (SSL) negotiation. ## Syntax ```text getSSLCert(): Certificate; setSSLCert(SSLCert: Certificate): void; ``` ## Default Value ## Remarks This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the field to the encoded certificate. To select a certificate, use the store and subject fields. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # [AzureFile](#azurefile-class).SSLProvider Property The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. ## Syntax ```text getSSLProvider(): AzureFileSSLProviders; setSSLProvider(SSLProvider: AzureFileSSLProviders): void; enum AzureFileSSLProviders { sslpAutomatic, sslpPlatform, sslpInternal } ``` ## Default Value 0 ## Remarks This property specifies the SSL/TLS implementation to use. In most cases the default value of *0* (Automatic) is recommended and should not be changed. When set to *0* (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used. Possible values are as follows: | | | | --- | --- | | 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. | | 1 (sslpPlatform) | Uses the platform/system implementation. | | 2 (sslpInternal) | Uses the internal implementation. | **Additional Notes** In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform. When Automatic is selected, the platform implementation will be used by default in all cases in the JavaScript edition. NOTE: The internal provider is not support at this time. # [AzureFile](#azurefile-class).SSLServerCert Property The server certificate for the last established connection. ## Syntax ```text getSSLServerCert(): Certificate; ``` ## Default Value ## Remarks This property contains the server certificate for the last established connection. SSLServerCert is reset every time a new connection is attempted. This property is read-only. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # [AzureFile](#azurefile-class).StartByte Property The byte offset from which to start the upload or download. ## Syntax ```text getStartByte(): number; setStartByte(startByte: number): void; ``` ## Default Value 0 ## Remarks This property may be set to resume an upload or download; it specifies the offset in the file from which to resume. See [UploadFile](#azurefileuploadfile-method) and [DownloadFile](#azurefiledownloadfile-method) for details about resuming uploads and downloads. This property is not available at design time. # [AzureFile](#azurefile-class).Timeout Property The timeout for the class. ## Syntax ```text getTimeout(): number; setTimeout(timeout: number): void; ``` ## Default Value 60 ## Remarks If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered. If Timeout is set to a positive value, the class will wait for the operation to complete before returning control. The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive. If Timeout expires, and the operation is not yet complete, the class . NOTE: By default, all timeouts are *inactivity timeouts*, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received. The default value for the Timeout property is 60 seconds. # [AzureFile](#azurefile-class).UseSSL Property Whether to use SSL/TLS when connecting. ## Syntax ```text isUseSSL(): boolean; setUseSSL(useSSL: boolean): void; ``` ## Default Value TRUE ## Remarks This property specifies whether the class should use SSL/TLS when connecting. This property is not available at design time. # [AzureFile](#azurefile-class).abortCopy Method Aborts a copy operation. ## Syntax ```text async azurefile.abortCopy(destFilePath : string, copyId : string): Promise< void> ``` ## Remarks This method aborts the copy operation identified by the given *CopyId* for the destination file at *DestFilePath* in the share currently selected by [Share](#azurefileshare-property). Note that the destination file will still exist after aborting a copy operation, but it will be empty. # [AzureFile](#azurefile-class).addMetadata Method Adds a metadata item to the Metadata properties. ## Syntax ```text async azurefile.addMetadata(name : string, value : string): Promise< void> ``` ## Remarks This method adds a metadata item to the [Metadata](#azurefilemetadata-property) collection. *Name* specifies the name of the item, and *Value* specifies the value of the item. Note that the class will automatically prepend *x-ms-meta-* to metadata item names (as necessary) when they are submitted to the server. Also note that while metadata item names are case-preserving, they are not case-sensitive. # [AzureFile](#azurefile-class).addQueryParam Method Adds a query parameter to the QueryParams properties. ## Syntax ```text async azurefile.addQueryParam(name : string, value : string): Promise< void> ``` ## Remarks This method is used to add a query parameter to the [QueryParams](#azurefilequeryparams-property) collection. *Name* specifies the name of the parameter, and *Value* specifies the value of the parameter. All specified *Value*s will be URL encoded by the class automatically. Consult the service documentation for details on the available parameters. # [AzureFile](#azurefile-class).authorize Method Get the authorization string required to access the protected resource. ## Syntax ```text async azurefile.authorize(): Promise< void> ``` ## Remarks This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the OAuthClientProfile property and the OAuthGrantType property. This method is **not** to be used in conjunction with the [Authorization](#azurefileauthorization-property) property. It should instead be used when setting the [OAuth](#azurefileoauth-property) property. For more information, see the introduction section. # [AzureFile](#azurefile-class).clearRange Method Clears a range of bytes from a file. ## Syntax ```text async azurefile.clearRange(filePath : string, first : number, last : number): Promise< void> ``` ## Remarks This method clears the range of bytes from *First* to *Last* (inclusive) from the file at *FilePath* in the share currently selected by [Share](#azurefileshare-property). The server tracks ranges of file data in 512-byte chunks, aligned to the absolute beginning of the file. When this method is called, the server frees any such chunks that are completely covered by the specified range of bytes (*[First]-[Last]*), and writes 0s to the appropriate portions of any chunks which are *not* completely covered by that range. Freed chunks are not included in the results returned by GetRanges. # [AzureFile](#azurefile-class).config Method Sets or retrieves a configuration setting. ## Syntax ```text async azurefile.config(configurationString : string): Promise< string> ``` ## Remarks Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-class-cloudstorageazurefile) for the class. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the Config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-class-cloudstorageazurefile), you must call *Config("PROPERTY")*. The value will be returned as a string. # [AzureFile](#azurefile-class).copyFile Method Copies a file. ## Syntax ```text async azurefile.copyFile(fromFilePath : string, toFilePath : string, toShare : string): Promise< string> ``` ## Remarks This method copies the file at *FromFilePath* (in the share currently selected by [Share](#azurefileshare-property)) to the path *ToFilePath* in the share *ToShare*. If this method finishes successfully, it will either return an asynchronous copy operation Id, or an empty string (if the copy has finished already). If *ToShare* is empty, the current value of [Share](#azurefileshare-property) will be used instead. If *ToShare* is non-empty, the value will automatically be lowercased when preparing the request. Any parent folders included in *ToFilePath* must already exist. If the destination file already exists, it will be overwritten. As long as the server doesn't return an error, this method will always populate the [CopyId](#CopyId) and [CopyStatus](#CopyStatus) configuration settings (and clear [CopyProgress](#CopyProgress) and [CopyStatusDesc](#CopyStatusDesc)). ### Asynchronous Copy Notes As mentioned, this method will return a copy operation Id if the copy operation was started asynchronously. In this case, use the [GetFileInfo](#azurefilegetfileinfo-method) method to poll the *destination* file's information, which will cause the [CopyStatus](#CopyStatus), [CopyStatusDesc](#CopyStatusDesc), and [CopyProgress](#CopyProgress) configuration settings to be refreshed. A copy operation whose [CopyStatus](#CopyStatus) is still *pending* may also be aborted by passing the copy operation Id returned by this method (or later retrieved from [CopyId](#CopyId)) to the [AbortCopy](#azurefileabortcopy-method) method. ```text // Copy a file to another location within the same share. string copyResult = azurefile.CopyFile("/folder1/important.zip", "/folder2/secrets.zip", ""); // If the returned value *isn't* empty string, then we'll monitor the status of the // asynchronous copy operation by polling once every 2 seconds using GetFileInfo(). if (!string.IsNullOrEmpty(copyResult)) { do { azurefile.GetFileInfo("/folder2/secrets.zip"); Console.WriteLine("Copy progress: " + azurefile.Config("CopyProgress")); } while (azurefile.Config("CopyStatus") == "pending"); } ``` # [AzureFile](#azurefile-class).createFile Method Initializes a new file. ## Syntax ```text async azurefile.createFile(newFilePath : string, fileLength : number): Promise< string> ``` ## Remarks This method initializes a new file with a given *FileLength* (in bytes) at the specified *NewFilePath* in the share currently selected by [Share](#azurefileshare-property). The path of the newly-initialized file is returned. Any parent folders included in *NewFilePath* must already exist. If the [SendMetadata](#SendMetadata) configuration setting is enabled when this method is called, all items in the [Metadata](#azurefilemetadata-property) collection will be sent along with the creation request. NOTE: This method is typically only useful for advanced use-cases. To upload a file, just call [UploadFile](#azurefileuploadfile-method). ### Usage Notes This method **does not** upload or otherwise allocate any data, it just creates the file entry and "reserves" storage space for it. After a file has been created with this method, the following methods can be used to manipulate its data: - The [PutRange](#azurefileputrange-method) method can be used to upload ranges of data (up to 4MB at once) to the file. - The [ClearRange](#azurefileclearrange-method) method can be used to clear an arbitrary range of data from the file, allowing the server to release the associated storage resources. - The GetRanges method can be used to obtain a list of all data ranges present in the file. # [AzureFile](#azurefile-class).createFolder Method Creates a new folder. ## Syntax ```text async azurefile.createFolder(newFolderPath : string): Promise< string> ``` ## Remarks This method creates a new folder at the specified *NewFolderPath* in the share currently selected by [Share](#azurefileshare-property). The path of the newly-created folder is returned. Any parent folders included in *NewFolderPath* must already exist. If the [SendMetadata](#SendMetadata) configuration setting is enabled when this method is called, all items in the [Metadata](#azurefilemetadata-property) collection will be sent along with the creation request. # [AzureFile](#azurefile-class).createShare Method Creates a new share. ## Syntax ```text async azurefile.createShare(): Promise< void> ``` ## Remarks This method creates a new share using the name specified by the [Share](#azurefileshare-property) property. If the [CreateShareQuota](#CreateShareQuota) configuration setting is a positive, non-zero integer when this method is called, the share will be created with a space quota of that many GB. A share's space quota may be changed at any time using the [SetShareQuota](#azurefilesetsharequota-method) method. If the [SendMetadata](#SendMetadata) configuration setting is enabled when this method is called, all items in the [Metadata](#azurefilemetadata-property) collection will be sent along with the creation request. ### Share Name Rules Share names must adhere to the following rules: - Must be 3 to 63 characters long. - Must start with a letter or number; and may only contain letters, numbers, and hyphens. - All letters much be lowercase. (For convenience, the class will automatically lowercase all letters in any value assigned to [Share](#azurefileshare-property).) - All hyphens must be immediately preceded *and* followed by a letter or number (consecutive hyphens are not allowed). # [AzureFile](#azurefile-class).deleteFile Method Deletes a file. ## Syntax ```text async azurefile.deleteFile(filePath : string): Promise< void> ``` ## Remarks This method deletes the file at the specified *FilePath* in the share currently selected by [Share](#azurefileshare-property). # [AzureFile](#azurefile-class).deleteFolder Method Deletes a folder. ## Syntax ```text async azurefile.deleteFolder(folderPath : string): Promise< void> ``` ## Remarks This method deletes the folder at the specified *FolderPath* in the share currently selected by [Share](#azurefileshare-property). Only empty folders may be deleted; non-empty folders must be emptied first. # [AzureFile](#azurefile-class).deleteShare Method Deletes a share. ## Syntax ```text async azurefile.deleteShare(): Promise< void> ``` ## Remarks This method deletes the share currently selected by the [Share](#azurefileshare-property) property. If the currently selected [Share](#azurefileshare-property) has any snapshots associated with it, and the [DeleteShareSnapshots](#DeleteShareSnapshots) configuration setting is disabled (default) when this method is called, the server will return an error. Shares with snapshots can only be deleted after enabling [DeleteShareSnapshots](#DeleteShareSnapshots). Note that, according to the Azure File Storage documentation, a share's name cannot be reused until at least 30 seconds after its deletion. # [AzureFile](#azurefile-class).downloadFile Method Downloads a file. ## Syntax ```text async azurefile.downloadFile(filePath : string): Promise< void> ``` ## Remarks This method downloads the file at the specified *FilePath* in the share currently selected by [Share](#azurefileshare-property). If [LocalFile](#azurefilelocalfile-property) is set, the file will be saved to the specified location; otherwise, the file data will be held by [ResourceData](#azurefileresourcedata-property). To download and decrypt an encrypted file, set [EncryptionAlgorithm](#azurefileencryptionalgorithm-property) and [EncryptionPassword](#azurefileencryptionpassword-property) before calling this method. ### Download Notes In the simplest use-case, downloading a file looks like this: ```text azurefile.LocalFile = "../MyFile.zip"; azurefile.DownloadFile(azurefile.Resources[0].Path); ``` **Resuming Downloads** The class also supports resuming failed downloads by using the [StartByte](#azurefilestartbyte-property) property. If a download is interrupted, set [StartByte](#azurefilestartbyte-property) to the appropriate offset before calling this method to resume the download. ```text 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](#azurefilelocalfile-property) was set in the initial download attempt. If [LocalFile](#azurefilelocalfile-property) is set when beginning an encrypted download, the class creates a temporary file in [TempPath](#TempPath) to hold the encrypted data until the download is complete. If the download is interrupted, [DownloadTempFile](#DownloadTempFile) will be populated with the path of the temporary file that holds the partial data. To resume, [DownloadTempFile](#DownloadTempFile) must be populated, along with [StartByte](#azurefilestartbyte-property), 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](#azurefilelocalfile-property). ```text 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); ``` # [AzureFile](#azurefile-class).getFileInfo Method Gets a file's information and metadata. ## Syntax ```text async azurefile.getFileInfo(filePath : string): Promise< void> ``` ## Remarks This method gets information and metadata for the file at the specified *FilePath* in the share currently selected by [Share](#azurefileshare-property). Calling this method will fire the [ResourceList](#azurefileresourcelist-event) event, will re-populate the [Resources](#azurefileresources-property) collection with a single item, and will re-populate the [Metadata](#azurefilemetadata-property) collection with any metadata currently associated with the file. # [AzureFile](#azurefile-class).getFolderInfo Method Gets a folder's information and metadata. ## Syntax ```text async azurefile.getFolderInfo(folderPath : string): Promise< void> ``` ## Remarks This method gets information and metadata for the folder at the specified *FolderPath* in the share currently selected by [Share](#azurefileshare-property). *FolderPath* can be empty string to get information about the root folder of the share. Calling this method will fire the [ResourceList](#azurefileresourcelist-event) event, will re-populate the [Resources](#azurefileresources-property) collection with a single item, and will re-populate the [Metadata](#azurefilemetadata-property) collection with any metadata currently associated with the folder. # [AzureFile](#azurefile-class).getLink Method Creates a link that provides access to a share or file. ## Syntax ```text async azurefile.getLink(filePath : string, permissions : string, startTime : string, expiryTime : string): Promise< string> ``` ## Remarks This method creates and returns a shared access signature (SAS), which is a link that provides access to a specific share or file. The following table indicates which inputs must be provided to produce a link of the desired type: | Link Type | Required Inputs | | --- | --- | | Share | Non-empty [Share](#azurefileshare-property), empty FilePath | | File | Non-empty [Share](#azurefileshare-property) and FilePath | *Permissions* specifies what permissions the SAS grants, in the form of an abbreviated permissions list. Refer to [this section](https://docs.microsoft.com/en-us/rest/api/storageservices/create-service-sas#specifying-permissions) of Azure's "Create a Service SAS" article for more information about how to format this value. *StartTime* and *ExpiryTime* specify the UTC start and end times of the SAS's validity interval. Refer to [this section](https://docs.microsoft.com/en-us/rest/api/storageservices/create-service-sas#specifying-the-signature-validity-interval) of Azure's "Create a Service SAS" article for more information about how to format these values. *StartTime* may be empty, in which case the server will assume that the link is valid immediately. *Permissions* and *ExpiryTime* must both be non-empty, unless an *si* query parameter that references a stored access policy (which has corresponding non-empty values) is present in the [QueryParams](#azurefilequeryparams-property) collection. If any of the query parameters listed below are present in the [QueryParams](#azurefilequeryparams-property) collection when this method is called, they will be included when creating the SAS. All other application-specified query parameters are ignored. - Response headers: *rscc*, *rscd*, *rsce*, *rscl*, *rsct* - IP address (single or range): *sip* - Allowed HTTP protocol(s): *spr* - Stored access policy ("signed identifier"): *si* For more information about SAS links, refer to Azure's [Create a Service SAS](https://docs.microsoft.com/en-us/rest/api/storageservices/create-service-sas) article. # [AzureFile](#azurefile-class).listRanges Method Gets the list of allocated data ranges in a file. ## Syntax ```text async azurefile.listRanges(filePath : string): Promise< void> ``` ## Remarks # [AzureFile](#azurefile-class).getShareInfo Method Gets a share's information and metadata. ## Syntax ```text async azurefile.getShareInfo(): Promise< void> ``` ## Remarks This method gets information and metadata for the share currently selected by the [Share](#azurefileshare-property) property. Calling this method will fire the [ShareList](#azurefilesharelist-event) event, will re-populate the [Shares](#azurefileshares-property) collection with a single item, and will re-populate the [Metadata](#azurefilemetadata-property) collection with any metadata currently associated with the share. # [AzureFile](#azurefile-class).interrupt Method This method interrupts the current method. ## Syntax ```text async azurefile.interrupt(): Promise< void> ``` ## Remarks If there is no method in progress, Interrupt simply returns, doing nothing. # [AzureFile](#azurefile-class).listResources Method Lists resources in a given folder. ## Syntax ```text async azurefile.listResources(folderPath : string): Promise< void> ``` ## Remarks This method lists the resources in the folder at the specified *FolderPath* in the share currently selected by [Share](#azurefileshare-property). Before calling this method, the [Prefix](#azurefileprefix-property) property may be set in order to restrict the results to only the items whose names begin with a given string. The [MaxResults](#MaxResults) configuration setting may also be used to limit the number of results returned. Calling this method will fire the [ResourceList](#azurefileresourcelist-event) event once for each resource, and will also populate the [Resources](#azurefileresources-property) collection. If there are still more resources available to list when this method returns, the [ResourceMarker](#azurefileresourcemarker-property) property will be populated. Continue to call this method until [ResourceMarker](#azurefileresourcemarker-property) is empty to accumulate all pages of results in the [Resources](#azurefileresources-property) collection. Alternatively, the [AccumulatePages](#AccumulatePages) configuration setting can be disabled to clear the [Resources](#azurefileresources-property) collection every time a page of results is returned. Note that the server only returns the following resource properties when listing resources (use [GetFileInfo](#azurefilegetfileinfo-method) or [GetFolderInfo](#azurefilegetfolderinfo-method) to retrieve all properties for a specific resource): - ResourcesName - ResourcesPath (populated by the class automatically) - ResourcesShare (populated by the class automatically) - ResourcesSize - ResourcesAccessType ```text // 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)); ``` # [AzureFile](#azurefile-class).listShares Method Lists shares in the file storage account. ## Syntax ```text async azurefile.listShares(): Promise< void> ``` ## Remarks This method lists the shares in the file storage account specified by the [Account](#azurefileaccount-property) property. Before calling this method, the [Prefix](#azurefileprefix-property) property may be set in order to restrict the results to only the items whose names begin with a given string. The [MaxResults](#MaxResults) configuration setting may also be used to limit the number of results returned. Calling this method will fire the [ShareList](#azurefilesharelist-event) event once for each share, and will also populate the [Shares](#azurefileshares-property) collection. If there are still more shares available to list when this method returns, the [ShareMarker](#azurefilesharemarker-property) property will be populated. Continue to call this method until [ShareMarker](#azurefilesharemarker-property) is empty to accumulate all pages of results in the [Shares](#azurefileshares-property) collection. Alternatively, the [AccumulatePages](#AccumulatePages) configuration setting can be disabled to clear the [Shares](#azurefileshares-property) collection every time a page of results is returned. Note that the server does not return the shares' SharesSpaceUsed property when listing shares; use [GetShareInfo](#azurefilegetshareinfo-method) to retrieve all properties for a specific share. ```text // ShareList event handler. azurefile.OnShareList += (s, e) => { Console.WriteLine(e.Name); }; do { azurefile.ListShares(); for (int i = 0; i < azurefile.Shares.Count; i++) { // Process shares here. } } while (!string.IsNullOrEmpty(azurefile.ShareMarker)); ``` # [AzureFile](#azurefile-class).putRange Method Uploads a range of data to a file. ## Syntax ```text async azurefile.putRange(filePath : string, writeOffset : number): Promise< void> ``` ## Remarks This method uploads a range of data to the file at the specified *FilePath* in the share currently selected by [Share](#azurefileshare-property). The data to upload cannot be larger than 4MB (4194304 bytes), and is written to the file at the given *WriteOffset* (specified in bytes). The server tracks ranges of file data in 512-byte chunks, aligned to the absolute beginning of the file. However, neither the *WriteOffset* nor the length of the data to upload need be a multiple of 512. Any portions of a chunk not written to will be populated with 0s. Note that, according to the Azure File Storage documentation, this operation requires a write lock on the entire file in order to complete successfully. # [AzureFile](#azurefile-class).renameFile Method Renames a file. ## Syntax ```text async azurefile.renameFile(oldFilePath : string, newFilePath : string): Promise< void> ``` ## Remarks This method moves and/or renames an existing file on the server at the specified *OldFilePath* in the share currently selected by [Share](#azurefileshare-property). The *NewFilePath* parameter indicates the new location and name of the file. Any parent folders included in *NewFilePath* must already exist. The [Overwrite](#azurefileoverwrite-property) property can optionally be enabled to overwrite the file if it already exists at the location specified by *NewFilePath*. # [AzureFile](#azurefile-class).renameFolder Method Renames a directory. ## Syntax ```text async azurefile.renameFolder(oldDirPath : string, newDirPath : string): Promise< void> ``` ## Remarks This method moves and/or renames an existing folder on the server at the specified *OldDirPath* in the share currently selected by [Share](#azurefileshare-property). The *NewDirPath* parameter indicates the new location and name of the folder. Any parent folders included in *NewDirPath* must already exist. # [AzureFile](#azurefile-class).reset Method Resets the class to its initial state. ## Syntax ```text async azurefile.reset(): Promise< void> ``` ## Remarks This method resets the class to its initial state. # [AzureFile](#azurefile-class).resizeFile Method Resizes a file. ## Syntax ```text async azurefile.resizeFile(filePath : string, newSize : number): Promise< void> ``` ## Remarks This method resizes the file at the specified *FilePath* in the share currently selected by [Share](#azurefileshare-property). *NewSize*, which is specified in bytes, cannot be negative. # [AzureFile](#azurefile-class).setDownloadStream Method Sets the stream to which downloaded data will be written. ## Syntax ```text async azurefile.setDownloadStream(downloadStream : WriteableStream): Promise< void> ``` ## Remarks If a download stream is set before data is downloaded, the downloaded data will be written to the stream. The stream should be open and normally set to position 0. Note: Passing a non-null value for *DownloadStream* will cause [LocalFile](#azurefilelocalfile-property) to be cleared. Similarly, setting [LocalFile](#azurefilelocalfile-property) to a non-empty value will discard any stream set using this method. # [AzureFile](#azurefile-class).setShareQuota Method Sets a share's space quota. ## Syntax ```text async azurefile.setShareQuota(quota : number): Promise< void> ``` ## Remarks This method sets the size, in GB, of the space quota imposed on the share currently selected by the [Share](#azurefileshare-property) property. *Quota* must be greater than 0. It *is* legal to lower a share's quota to a value less than its current space usage. However, doing so will prevent new space from being allocated until either the space usage falls below quota or the quota is raised above the space usage. # [AzureFile](#azurefile-class).setUploadStream Method Sets the stream from which data is read when uploading. ## Syntax ```text async azurefile.setUploadStream(uploadStream : ReadableStream): Promise< void> ``` ## Remarks If an upload stream is set before data is uploaded, the content of the stream will be read by the class and uploaded to the server. The stream should be open and normally set to position 0. Note: Passing a non-null value for *UploadStream* will cause [LocalFile](#azurefilelocalfile-property) to be cleared. Similarly, setting [LocalFile](#azurefilelocalfile-property) to a non-empty value will discard any stream set using this method. # [AzureFile](#azurefile-class).updateMetadata Method Sets the metadata for a file, folder, or share. ## Syntax ```text async azurefile.updateMetadata(path : string, resourceType : number): Promise< void> ``` ## Remarks This method sets the metadata for a file, folder, or share to the items currently held by the [Metadata](#azurefilemetadata-property) collection. The *ResourceType* parameter indicates the kind of resource the class should prepare the request for; possible values are: - *0*: Set the metadata for the file at the specified *Path* in the share currently selected by [Share](#azurefileshare-property). - *1*: Set the metadata for the folder at the specified *Path* in the share currently selected by [Share](#azurefileshare-property). - *2*: Set the metadata for the share currently selected by [Share](#azurefileshare-property) (*Path* is ignored). Note that it is not possible to do a partial metadata update. That is, all metadata currently associated with the remote entity will be replaced with the metadata sent in the request. # [AzureFile](#azurefile-class).uploadFile Method Uploads a new file resource. ## Syntax ```text async azurefile.uploadFile(newFilePath : string): Promise< string> ``` ## Remarks This method uploads a new file resource at the specified *NewFilePath* in the share currently selected by [Share](#azurefileshare-property). The path of the newly-created file is returned. Any parent folders included in *NewFilePath* must already exist. If the [SendMetadata](#SendMetadata) configuration setting is enabled when this method is called, all items in the [Metadata](#azurefilemetadata-property) collection will be sent along with the creation request. If [LocalFile](#azurefilelocalfile-property) is set the file will be uploaded from the specified path. If [LocalFile](#azurefilelocalfile-property) is not set the data in [ResourceData](#azurefileresourcedata-property) will be used. To encrypt the file before uploading it, set [EncryptionAlgorithm](#azurefileencryptionalgorithm-property) and [EncryptionPassword](#azurefileencryptionpassword-property). ### Upload Notes The UploadFile method is a convenience method that performs a resumable file upload. When called, the class first uses [CreateFile](#azurefilecreatefile-method) to initialize a new file entry on the server; and then it fragments the file data into smaller pieces and calls [PutRange](#azurefileputrange-method) 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](#azurefilefragmentcomplete-event) event fires after each fragment is uploaded to indicate overall progress. The class also updates [StartByte](#azurefilestartbyte-property) 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](#azurefilestartbyte-property) 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](#azurefilestartbyte-property) offset. ```text azurefile.LocalFile = "../MyFile.zip"; azurefile.UploadFile("MyFile.zip"); //The transfer is interrupted and UploadFile() above fails. Later, resume the upload. //Using the same instance StartByte is already populated from the previous upload attempt. azurefile.UploadFile("MyFile.zip"); ``` # [AzureFile](#azurefile-class).EndTransfer Event Fired when a document finishes transferring. ## Syntax ```text azurefile.on('EndTransfer', listener: (e: {readonly direction: number}) => void ) ``` ## Remarks This event is fired first when the client finishes sending data to the server (in a *POST* or *PUT* request) and then when the document text finishes transferring from the server to the local host. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. # [AzureFile](#azurefile-class).Error Event Fired when information is available about errors during data delivery. ## Syntax ```text azurefile.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void ) ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the class . The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-class-cloudstorageazurefile) section. # [AzureFile](#azurefile-class).FragmentComplete Event Fires after each fragment of a resumable upload is completed. ## Syntax ```text azurefile.on('FragmentComplete', listener: (e: {readonly fragmentNumber: number, readonly fragmentCount: number, interrupt: boolean}) => void ) ``` ## Remarks When [UploadFile](#azurefileuploadfile-method) is called, this event will fire after each fragment is uploaded, providing an indication of overall upload progress. *FragmentNumber* is the number of the current fragment that has completed. This value begins at 1. *FragmentCount* is the total number of fragments that will be uploaded. *Interrupt* can be set to *true* to interrupt the upload. The upload may be resumed later. # [AzureFile](#azurefile-class).Header Event Fired every time a header line comes in. ## Syntax ```text azurefile.on('Header', listener: (e: {readonly field: string, readonly value: string}) => void ) ``` ## Remarks The *Field* parameter contains the name of the HTTP header (which is the same as it is delivered). The *Value* parameter contains the header contents. If the header line being retrieved is a continuation header line, then the *Field* parameter contains "" (empty string). # [AzureFile](#azurefile-class).Log Event Fired once for each log message. ## Syntax ```text azurefile.on('Log', listener: (e: {readonly logLevel: number, readonly message: string, readonly logType: string}) => void ) ``` ## Remarks This event is fired once for each log message generated by the class. The verbosity is controlled by the [LogLevel](#LogLevel) setting. *LogLevel* indicates the level of message. Possible values are as follows: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data are logged. | | 3 (Debug) | Debug data are logged. | The value 1 (Info) logs basic information, including the URL, HTTP version, and status details. The value 2 (Verbose) logs additional information about the request and response. The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any). *Message* is the log entry. *LogType* identifies the type of log entry. Possible values are as follows: - "Info" - "RequestHeaders" - "ResponseHeaders" - "RequestBody" - "ResponseBody" - "ProxyRequest" - "ProxyResponse" - "FirewallRequest" - "FirewallResponse" # [AzureFile](#azurefile-class).Progress Event Fires during an upload or download to indicate transfer progress. ## Syntax ```text azurefile.on('Progress', listener: (e: {readonly direction: number, readonly bytesTransferred: number, readonly totalBytes: number, readonly percentDone: number}) => void ) ``` ## Remarks This event fires during an upload or download to indicate the progress of the transfer of the entire request. By default, this event will fire each time *PercentDone* increases by one percent; the [ProgressStep](#ProgressStep) configuration setting can be used to alter this behavior. *Direction* indicates whether the transfer is an upload (*0*) or a download (*1*). *BytesTransferred* reflects the number of bytes that have been transferred so far, or *0* if the transfer is starting (however, see note below). *TotalBytes* reflects the total number of bytes that are to be transferred, or *-1* if the total is unknown. This amount includes the size of everything in the request like HTTP headers. *PercentDone* reflects the overall progress of the transfer, or *-1* if the progress cannot be calculated. NOTE: By default, the class tracks transfer progress *absolutely*. If a transfer is interrupted and later resumed, the values reported by this event upon and after resumption will account for the data that was transferred *before* the interruption. For example, if 10MB of data was successfully transferred before the interruption, then this event will fire with a *BytesTransferred* value of *10485760* (10MB) when the transfer is first resumed, and then continue to fire with successively greater values as usual. This behavior can be changed by disabling the [ProgressAbsolute](#ProgressAbsolute) configuration setting, in which case the class will treat resumed transfers as "new" transfers. In this case, the *BytesTransferred* parameter will always be *0* the first time this event fires, regardless of whether the transfer is new or being resumed. # [AzureFile](#azurefile-class).ResourceList Event Fires once for each resource returned when listing resources. ## Syntax ```text azurefile.on('ResourceList', listener: (e: {readonly name: string, readonly path: string, readonly share: string, readonly resourceType: number, readonly modifiedTime: string, readonly size: number, readonly ETag: string}) => void ) ``` ## Remarks This event fires once for each resource returned when [ListResources](#azurefilelistresources-method), [GetFileInfo](#azurefilegetfileinfo-method), or [GetFolderInfo](#azurefilegetfolderinfo-method) is called. *Name* is the name of the resource. *Path* is the full path of the resource (not including the share). *Share* is the name of the share the resource resides in. *ResourceType* reflects the resource's type. Possible values are: | | | | --- | --- | | 0 (afrtFile) | A file. | | 1 (afrtFolder) | A folder. | *ModifiedTime* is the last modified time of the resource, formatted according to RFC 1123. (Note: this parameter is not populated by calls to [ListResources](#azurefilelistresources-method).) *Size* is the size of the file. Always 0 for folders. *ETag* is the ETag of the resource. (Note: this parameter is not populated by calls to [ListResources](#azurefilelistresources-method).) # [AzureFile](#azurefile-class).ShareList Event Fires once for each share returned when listing shares. ## Syntax ```text azurefile.on('ShareList', listener: (e: {readonly name: string, readonly modifiedTime: string, readonly ETag: string, readonly quota: number}) => void ) ``` ## Remarks This event fires once for each share returned when [ListShares](#azurefilelistshares-method) or [GetShareInfo](#azurefilegetshareinfo-method) is called. *Name* is the name of the share. *ModifiedTime* is the last modified time of the share, formatted according to RFC 1123. *ETag* is the ETag of the share. *Quota* is the share's space quota, in GB. # [AzureFile](#azurefile-class).SSLServerAuthentication Event Fired after the server presents its certificate to the client. ## Syntax ```text azurefile.on('SSLServerAuthentication', listener: (e: {readonly certEncoded: string, readonly certEncodedB: Uint8Array, readonly certSubject: string, readonly certIssuer: string, readonly status: string, accept: boolean}) => void ) ``` ## Remarks This event fires with information about the server certificate. The *Status* property shows why verification failed (otherwise, *Status* contains the string *OK*). To manually accept an untrusted certificate, the [SSLAcceptAnyServerCert](#SSLAcceptAnyServerCert) setting must be set to True before initiating the connection. # [AzureFile](#azurefile-class).SSLStatus Event Fired when secure connection progress messages are available. ## Syntax ```text azurefile.on('SSLStatus', listener: (e: {readonly message: string}) => void ) ``` ## Remarks The event is fired for informational and logging purposes only. This event tracks the progress of the connection. # [AzureFile](#azurefile-class).StartTransfer Event Fired when a document starts transferring (after the headers). ## Syntax ```text azurefile.on('StartTransfer', listener: (e: {readonly direction: number}) => void ) ``` ## Remarks This event is fired first when the client starts sending data to the server (in a *POST* or *PUT* request) and then when the document text starts transferring from the server to the local host. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. # [AzureFile](#azurefile-class).Transfer Event Fired while a document transfers (delivers document). ## Syntax ```text azurefile.on('Transfer', listener: (e: {readonly direction: number, readonly bytesTransferred: number, readonly percentDone: number, readonly text: string, readonly textB: Uint8Array}) => void ) ``` ## Remarks The *Text* parameter contains the portion of the document text being received. It is empty if data are being posted to the server. The *BytesTransferred* parameter contains the number of bytes transferred in this *Direction* since the beginning of the document text (excluding HTTP response headers). The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. The *PercentDone* parameter shows the progress of the transfer in the corresponding direction. If *PercentDone* can not be calculated the value will be -1. NOTE: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance. # AzureFileResource Type An Azure File service file or folder. ## Remarks This type represents an Azure File service file or folder. The following fields are available: - [ContentMD5](#AzureFileResource_f_ContentMD5) - [ContentType](#AzureFileResource_f_ContentType) - [ETag](#AzureFileResource_f_ETag) - [ModifiedTime](#AzureFileResource_f_ModifiedTime) - [Name](#AzureFileResource_f_Name) - [Path](#AzureFileResource_f_Path) - [ResourceType](#AzureFileResource_f_ResourceType) - [Share](#AzureFileResource_f_Share) - [Size](#AzureFileResource_f_Size) ## Fields **ContentMD5** *string (read-only)* *Default Value: ""* An MD5 hash of the file's content. This property reflects the MD5 hash of the file's content, if one is returned by the server. Always empty for folders. **ContentType** *string (read-only)* *Default Value: ""* The content type of the resource. This property reflects the content type of the resource. **ETag** *string (read-only)* *Default Value: ""* The ETag of the resource. This property reflects the ETag of the resource. **ModifiedTime** *string (read-only)* *Default Value: ""* The last modified time of the resource. This property reflects the last modified time of the resource, formatted according to RFC 1233. **Name** *string (read-only)* *Default Value: ""* The name of the resource. This property reflects the name of the resource. **Path** *string (read-only)* *Default Value: ""* The path of the resource. This property reflects the path of the resource (not including the name of the share it resides in; see ). **ResourceType** *AzureFileResourceTypes (read-only)* *Default Value: 0* The resource's type. This property indicates whether the resource is a folder or a file. Possible values are: | | | | --- | --- | | 0 (afrtFile) | A file. | | 1 (afrtFolder) | A folder. | **Share** *string (read-only)* *Default Value: ""* The name of the share the resource resides in. This property reflects the name of the share the resource resides in. **Size** *number (read-only)* *Default Value: 0* The size of the file. This property reflects the size, in bytes, of the file resource. Always 0 for folders. ## Constructors ```text public AzureFileResource(); ``` # AzureFileShare Type An Azure File service share. ## Remarks This type represents an Azure File service share. The following fields are available: - [ETag](#AzureFileShare_f_ETag) - [ModifiedTime](#AzureFileShare_f_ModifiedTime) - [Name](#AzureFileShare_f_Name) - [Quota](#AzureFileShare_f_Quota) - [SpaceUsed](#AzureFileShare_f_SpaceUsed) ## Fields **ETag** *string (read-only)* *Default Value: ""* The ETag of the share. This property reflects the ETag of the share. **ModifiedTime** *string (read-only)* *Default Value: ""* The last modified time of the share. This property reflects the last modified time of the share, formatted according to RFC 1123. Note that the share's last modified time is *not* updated by operations against resources within the share. **Name** *string (read-only)* *Default Value: ""* The name of the share. This property reflects the name of the share. **Quota** *number (read-only)* *Default Value: 0* The share's space quota, in GB. This property reflects the space quota, in GB, imposed on the share. **SpaceUsed** *number (read-only)* *Default Value: 0* The amount of storage space consumed by the share. This property reflects the approximate amount of storage space, in GB, the share is consuming. ## Constructors ```text public AzureFileShare(); ``` # AzureMetadata Type An Azure metadata item. ## Remarks This type represents an Azure metadata item. The following fields are available: - [Name](#AzureMetadata_f_Name) - [Value](#AzureMetadata_f_Value) ## Fields **Name** *string* *Default Value: ""* The name of the metadata item. This property specifies the name of the metadata item. Note that metadata item names are case-preserving, but not case-sensitive. Note that the class will automatically prepend *x-ms-meta-* to this value when submitting metadata items to the server; and will automatically strip that prefix from this value when retrieving them from the server. **Value** *string* *Default Value: ""* The value of the metadata item. This property specifies the value of the metadata item. ## Constructors ```text public AzureMetadata(); ``` ```text public AzureMetadata(String name, String value); ``` # AzureRange Type An Azure byte range. ## Remarks This type represents an Azure byte range. The following fields are available: - [First](#AzureRange_f_First) - [Last](#AzureRange_f_Last) ## Fields **First** *number (read-only)* *Default Value: 0* The first byte of the range. This property specifies the first byte (inclusive) of the byte range. **Last** *number (read-only)* *Default Value: 0* The last byte of the range. This property specifies the last byte (inclusive) of the byte range. # Certificate Type This is the digital certificate being used. ## Remarks This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates. The following fields are available: - [EffectiveDate](#Certificate_f_EffectiveDate) - [ExpirationDate](#Certificate_f_ExpirationDate) - [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage) - [Fingerprint](#Certificate_f_Fingerprint) - [FingerprintSHA1](#Certificate_f_FingerprintSHA1) - [FingerprintSHA256](#Certificate_f_FingerprintSHA256) - [Issuer](#Certificate_f_Issuer) - [KeyPassword](#Certificate_f_KeyPassword) - [PrivateKey](#Certificate_f_PrivateKey) - [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) - [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer) - [PublicKey](#Certificate_f_PublicKey) - [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm) - [PublicKeyLength](#Certificate_f_PublicKeyLength) - [SerialNumber](#Certificate_f_SerialNumber) - [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm) - [Store](#Certificate_f_Store) - [StorePassword](#Certificate_f_StorePassword) - [StoreType](#Certificate_f_StoreType) - [SubjectAltNames](#Certificate_f_SubjectAltNames) - [ThumbprintMD5](#Certificate_f_ThumbprintMD5) - [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1) - [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256) - [Usage](#Certificate_f_Usage) - [UsageFlags](#Certificate_f_UsageFlags) - [Version](#Certificate_f_Version) - [Subject](#Certificate_f_Subject) - [Encoded](#Certificate_f_Encoded) ## Fields **EffectiveDate** *string (read-only)* *Default Value: ""* The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. **ExpirationDate** *string (read-only)* *Default Value: ""* The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. **ExtendedKeyUsage** *string (read-only)* *Default Value: ""* A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). **Fingerprint** *string (read-only)* *Default Value: ""* The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* **FingerprintSHA1** *string (read-only)* *Default Value: ""* The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* **FingerprintSHA256** *string (read-only)* *Default Value: ""* The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* **Issuer** *string (read-only)* *Default Value: ""* The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. **KeyPassword** *string* *Default Value: ""* The password for the certificate's private key (if any). Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the . This property can be used to read such password-protected private keys. NOTE: This property defaults to the value of . To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling . **PrivateKey** *string (read-only)* *Default Value: ""* The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The may be available but not exportable. In this case, returns an empty string. **PrivateKeyAvailable** *boolean (read-only)* *Default Value: False* Whether a is available for the selected certificate. If is True, the certificate may be used for authentication purposes (e.g., server authentication). **PrivateKeyContainer** *string (read-only)* *Default Value: ""* The name of the container for the certificate (if available). This functionality is available only on Windows platforms. **PublicKey** *string (read-only)* *Default Value: ""* The public key of the certificate. The key is provided as PEM/Base64-encoded data. **PublicKeyAlgorithm** *string (read-only)* *Default Value: ""* The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. **PublicKeyLength** *number (read-only)* *Default Value: 0* The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. **SerialNumber** *string (read-only)* *Default Value: ""* The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. **SignatureAlgorithm** *string (read-only)* *Default Value: ""* The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. **Store** *string* *Default Value: "MY"* The name of the certificate store for the client certificate. The property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in . is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **StoreB** *Uint8Array* *Default Value: "MY"* The name of the certificate store for the client certificate. The property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in . is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **StorePassword** *string* *Default Value: ""* If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. **StoreType** *CertStoreTypes* *Default Value: 0* The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [](#f_StoreType), the full path of the PKCS#11 DLL as the [](#f_Store), and the PIN as the [](#f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the CertMgr class by calling the ListStoreCertificates method after setting the corresponding properties accordingly. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [](#f_Store) and set [](#f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | **SubjectAltNames** *string (read-only)* *Default Value: ""* Comma-separated lists of alternative subject names for the certificate. **ThumbprintMD5** *string (read-only)* *Default Value: ""* The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **ThumbprintSHA1** *string (read-only)* *Default Value: ""* The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **ThumbprintSHA256** *string (read-only)* *Default Value: ""* The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **Usage** *string (read-only)* *Default Value: ""* The text description of . This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. **UsageFlags** *number (read-only)* *Default Value: 0* The flags that show intended use for the certificate. The value of is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the property for a text representation of . This functionality currently is not available when the provider is OpenSSL. **Version** *string (read-only)* *Default Value: ""* The certificate's version number. The possible values are the strings "V1", "V2", and "V3". **Subject** *string* *Default Value: ""* The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. **Encoded** *string* *Default Value: ""* The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate. When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string. **EncodedB** *Uint8Array* *Default Value: ""* The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate. When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string. ## Constructors ```text public Certificate(); ``` Creates a instance whose properties can be set. ```text public Certificate(String certificateFile); ``` Opens * CertificateFile * and reads out the contents as an X.509 public key. ```text public Certificate(byte[] encoded); ``` Parses * Encoded * as an X.509 public key. ```text public Certificate(int storeType, String store, String storePassword, String subject); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, String store, String storePassword, String subject, String configurationString); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. * ConfigurationString * is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the * cstUser * , * cstMachine * , * cstPublicKeyFile * , and * cstPFXFile * store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, String store, String storePassword, byte[] encoded); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key. ```text public Certificate(int storeType, byte[] store, String storePassword, String subject); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, byte[] store, String storePassword, String subject, String configurationString); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, byte[] store, String storePassword, byte[] encoded); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key. # Firewall Type The firewall the class will connect through. ## Remarks When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall and the . The following fields are available: - [AutoDetect](#Firewall_f_AutoDetect) - [FirewallType](#Firewall_f_FirewallType) - [Host](#Firewall_f_Host) - [Password](#Firewall_f_Password) - [Port](#Firewall_f_Port) - [User](#Firewall_f_User) ## Fields **AutoDetect** *boolean* *Default Value: False* Whether to automatically detect and use firewall system settings, if available. **FirewallType** *FirewallTypes* *Default Value: 0* The type of firewall to connect through. The applicable values are as follows: | | | | --- | --- | | fwNone (0) | No firewall (default setting). | | fwTunnel (1) | Connect through a tunneling proxy. [](#f_Port) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [](#f_Port) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [](#f_Port) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [](#f_Port) is set to 1080. | **Host** *string* *Default Value: ""* The name or IP address of the firewall (optional). If a is given, the requested connections will be authenticated through the specified firewall when connecting. If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class . **Password** *string* *Default Value: ""* A password if authentication is to be used when connecting through the firewall. If is specified, the and properties are used to connect and authenticate to the given firewall. If the authentication fails, the class . **Port** *number* *Default Value: 0* The Transmission Control Protocol (TCP) port for the firewall . See the description of the property for details. NOTE: This property is set automatically when is set to a valid value. See the description of the property for details. **User** *string* *Default Value: ""* A username if authentication is to be used when connecting through a firewall. If is specified, this property and the property are used to connect and authenticate to the given [Firewall](#firewall-type). If the authentication fails, the class . ## Constructors ```text public Firewall(); ``` # Header Type This is an HTTP header as it is received from the server. ## Remarks When a header is received through a Header event, it is parsed into a [Header](#header-type) type. This type contains a , and its corresponding . The following fields are available: - [Field](#Header_f_Field) - [Value](#Header_f_Value) ## Fields **Field** *string* *Default Value: ""* This property contains the name of the HTTP [Header](#header-type) (this is the same case as it is delivered). **Value** *string* *Default Value: ""* This property contains the [Header](#header-type) contents. ## Constructors ```text public Header(); ``` ```text public Header(String field, String value); ``` # OAuthSettings Type The settings used to authenticate with the service provider. ## Remarks This type is used to give the class the necessary information needed to complete the OAuth process. The following fields are available: - [AccessToken](#OAuthSettings_f_AccessToken) - [AuthorizationCode](#OAuthSettings_f_AuthorizationCode) - [AuthorizationScope](#OAuthSettings_f_AuthorizationScope) - [ClientId](#OAuthSettings_f_ClientId) - [ClientProfile](#OAuthSettings_f_ClientProfile) - [ClientSecret](#OAuthSettings_f_ClientSecret) - [GrantType](#OAuthSettings_f_GrantType) - [RefreshToken](#OAuthSettings_f_RefreshToken) - [RequestRefreshToken](#OAuthSettings_f_RequestRefreshToken) - [ReturnURL](#OAuthSettings_f_ReturnURL) - [ServerAuthURL](#OAuthSettings_f_ServerAuthURL) - [ServerTokenURL](#OAuthSettings_f_ServerTokenURL) - [Timeout](#OAuthSettings_f_Timeout) - [WebAuthURL](#OAuthSettings_f_WebAuthURL) ## Fields **AccessToken** *string* *Default Value: ""* The access token returned by the authorization server. This is set when the class makes a request to the token server. **AuthorizationCode** *string* *Default Value: ""* The authorization code that is exchanged for an access token. This is required to be set when the OAuthClientProfile property is set to the Web profile. Otherwise, this field is for information purposes only. **AuthorizationScope** *string* *Default Value: ""* The scope request or response parameter used during authorization. **ClientId** *string* *Default Value: ""* The id of the client assigned when registering the application. **ClientProfile** *CloudOAuthClientProfiles* *Default Value: 0* The type of client that is requesting authorization. See the introduction section for more information. Possible values are: | | | | --- | --- | | 0 (cocpApplication - Default) | The application profile is applicable to applications that are run by the user directly. For instance a windows form application would use the application profile. To authorize your application (client) using the application profile see the introduction section. | | 1 (cocpWeb) | The Web profile is applicable to applications that are run on the server side where the user uses the application from a web browser. To authorize your application (client) using this profile follow see the introduction section. | **ClientSecret** *string* *Default Value: ""* The secret value for the client assigned when registering the application. **GrantType** *OAuthSettingsGrantTypes* *Default Value: 0* The OAuth grant type used to acquire an OAuth access token. See the introduction section for more information. Possible values are: | | | | --- | --- | | 0 (cogtAuthorizationCode - Default) | Authorization Code grant type | | 1 (cogtImplicit) | Implicit grant type | | 2 (cogtPassword) | Resource Owner Password Credentials grant type | | 3 (cogtClientCredentials) | Client Credentials grant type | **RefreshToken** *string* *Default Value: ""* Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the OAuthGrantType property is set to a grant that can use refresh tokens. **RequestRefreshToken** *boolean* *Default Value: True* Specifies whether the class will request a refresh token during authorization. By default, this value is *True*. When *True*, the class will automatically add the necessary scopes or parameters to obtain a refresh token. When *False*, this property will have no effect. If the necessary scopes or parameters are specified manually, a refresh token can still be obtained. NOTE: This property is only applicable when the OAuthGrantType property is set to *cogtAuthorizationCode*. **ReturnURL** *string* *Default Value: ""* The URL where the user (browser) returns after authenticating. This property is mapped to the *redirect_uri* parameter when making a request to the authorization server. Typically, this is automatically set by the class when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing. **ServerAuthURL** *string* *Default Value: ""* The URL of the authorization server. **ServerTokenURL** *string* *Default Value: ""* The URL of the token server used to obtain the access token. **Timeout** *number* *Default Value: 60* The amount of time (in seconds) the component will wait for a response from the browser in the LaunchBrowser event. The default value is 60. **WebAuthURL** *string (read-only)* *Default Value: ""* The URL to which the user should be re-directed for authorization. This field is used to get the URL that the user should be redirected to when using the Web client profile. See introduction section for more information. ## Constructors ```text public OAuthSettings(); ``` # Proxy Type The proxy the class will connect to. ## Remarks When connecting through a proxy, this type is used to specify different properties of the proxy, such as the and the . The following fields are available: - [AuthScheme](#Proxy_f_AuthScheme) - [AutoDetect](#Proxy_f_AutoDetect) - [Password](#Proxy_f_Password) - [Port](#Proxy_f_Port) - [Server](#Proxy_f_Server) - [SSL](#Proxy_f_SSL) - [User](#Proxy_f_User) ## Fields **AuthScheme** *ProxyAuthSchemes* *Default Value: 0* The type of authorization to perform when connecting to the proxy. This is used only when the and properties are set. should be set to authNone (3) when no authentication is expected. By default, is authBasic (0), and if the and properties are set, the class will attempt basic authentication. If is set to authDigest (1), digest authentication will be attempted instead. If is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token. If is set to authNtlm (4), NTLM authentication will be used. For security reasons, setting this property will clear the values of and . **AutoDetect** *boolean* *Default Value: False* Whether to automatically detect and use proxy system settings, if available. The default value is *false*. **Password** *string* *Default Value: ""* A password if authentication is to be used for the proxy. If is set to Basic Authentication, the and properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If is set to Digest Authentication, the and properties are used to respond to the Digest Authentication challenge from the server. If is set to NTLM Authentication, the and properties are used to authenticate through NTLM negotiation. **Port** *number* *Default Value: 80* The Transmission Control Protocol (TCP) port for the proxy (default 80). See the description of the property for details. **Server** *string* *Default Value: ""* If a proxy is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the property is set to the corresponding address. If the search is not successful, an error is returned. **SSL** *ProxySSLTypes* *Default Value: 0* When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows: | | | | --- | --- | | psAutomatic (0) | Default setting. If the URL is an https URL, the class will use the psTunnel option. If the URL is an http URL, the class will use the psNever option. | | psAlways (1) | The connection is always SSL-enabled. | | psNever (2) | The connection is not SSL-enabled. | | psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. | **User** *string* *Default Value: ""* A username if authentication is to be used for the proxy. If is set to Basic Authentication, the and properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If is set to Digest Authentication, the and properties are used to respond to the Digest Authentication challenge from the server. If is set to NTLM Authentication, the and properties are used to authenticate through NTLM negotiation. ## Constructors ```text public Proxy(); ``` ```text public Proxy(String server, int port); ``` ```text public Proxy(String server, int port, String user, String password); ``` # QueryParam Type A query parameter to send in the request. ## Remarks This type represents a query parameter to send in the request. The following fields are available: - [Name](#QueryParam_f_Name) - [Value](#QueryParam_f_Value) ## Fields **Name** *string* *Default Value: ""* The name of the query parameter. This property specifies the name of the query parameter. **Value** *string* *Default Value: ""* The value of the query parameter. This property specifies the value of the query parameter. The class will automatically URL-encode this value when sending the request. ## Constructors ```text public QueryParam(); ``` ```text public QueryParam(String name, String value); ``` # ReadableStream Type ## Syntax ```text interface ReadableStream { read(buffer: Uint8Array, offset: number, length: number): Promise; readSync(buffer: Uint8Array, offset: number, length: number): number; available(): number; close(): void; mark():void; reset():void; markSupported():boolean; } ``` ## Remarks The AzureFile class includes one or more API methods that accept a stream object as a parameter. To use such API members, create a custom object that implements the ReadableStream interface, and pass an instance of this object to the AzureFile class. When implementing the ReadableStream interface's properties and methods, they must behave as described below. If the implementation does not behave as expected, undefined behavior may occur. ```text read(buffer: Uint8Array, offset: number, length: number): Promise { } ``` ```text readSync(buffer: Uint8Array, offset: number, length: number): number { } ``` ```text available(): number { } ``` ```text close(): void { } ``` ```text mark(): void { } ``` ```text reset(): void { } ``` ```text markSupported(): boolean { } ``` | | | | --- | --- | | Methods | | | The following parameters are supported | buffer: The buffer to store the read data.
offset: The starting position within the buffer to write data.
length: The maximum number of bytes to read.
| | read | Reads data from the stream into the provided buffer. This method must be implemented.
Returns a promise resolving to the number of bytes read, -1 if no data is available. | | readSync | Synchronously reads data from the stream into the buffer. Returns the number of bytes read, -1 if no data is available. | | available | Returns the number of bytes available for reading. This method must be implemented.
| | close | Closes the stream and releases associated resources. | | mark | Marks the current position in this stream. | | reset | Repositions this stream to the position at the time the mark method was last called. | | markSupported | Tests if this stream supports the mark and reset methods. Returns true if this stream supports the mark and reset methods; false otherwise. | # WriteableStream Type ## Syntax ```text interface WriteableStream { write(data: Uint8Array, offset: number, length: number): Promise; writeSync(data: Uint8Array, offset: number, length: number): void; close(): void; } ``` ## Remarks The AzureFile class includes one or more API methods that accept a stream object as a parameter. To use such API members, create a custom object that implements the WriteableStream interface, and pass an instance of this object to the AzureFile class. When implementing the WriteableStream interface's properties and methods, they must behave as described below. If the implementation does not behave as expected, undefined behavior may occur. ```text write(data: Uint8Array, offset: number, length: number): Promise { } ``` ```text writeSync(data: Uint8Array, offset: number, length: number): void { } ``` ```text close(): void { } ``` | | | | --- | --- | | Methods | | | The following parameters are supported | data: The buffer containing the data to write.
offset: The starting position in the buffer to read data from.
length: The maximum number of bytes to write.
| | write | Asynchronously writes data from the provided buffer to the stream. This method must be implemented.
Returns a promise that resolves when the write operation completes. | | writeSync | Synchronously writes data from the buffer to the stream. | | close | Closes the stream and releases associated resources. | # Config Settings (*class *cloudstorage.[azurefile](#azurefile-class)) The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [Config](#azurefileconfig-method) method. ### AzureFile Config Settings **AccumulatePages**: Whether the class should accumulate subsequent pages of results when listing them.This setting controls how the class behaves when listing multiple pages of results. If this setting is enabled, each successive page of results will be appended to the appropriate collection properties until the last page of results has been listed (at which point the next list call will cause said collection to be cleared first). If this setting is disabled, the collection will be cleared every time a page of results is returned. By default, this setting is enabled, allowing all pages of results to be accumulated in the appropriate collection properties. **APIVersion**: The Azure Storage REST API version being used by the class.This setting can be queried to obtain the version of the Azure Storage REST APIs being used by the class. Note that this setting cannot be changed. **CopyId**: The Id of a copy operation.This setting can be queried to obtain the Id of a copy operation. This setting is populated after calling [CopyFile](#azurefilecopyfile-method), or after calling [GetFileInfo](#azurefilegetfileinfo-method) for the destination file in a copy operation. **CopyProgress**: The progress of a copy operation.This setting can be queried to obtain the progress of a copy operation, which is representing as the number of bytes copied out of the total number of bytes (e.g., *273/3620*). Calling [CopyFile](#azurefilecopyfile-method) will clear this setting; call [GetFileInfo](#azurefilegetfileinfo-method) for the destination file in a copy operation to populate it. **CopyStatus**: The status of a copy operation.This setting can be queried to obtain the status of a copy operation. Possible values are: - *pending* - *success* - *aborted* - *failed* This setting is populated after calling [CopyFile](#azurefilecopyfile-method), or after calling [GetFileInfo](#azurefilegetfileinfo-method) for the destination file in a copy operation. **CopyStatusDesc**: The status description for a copy operation.This setting can be queried to obtain a description of a copy operation's status. The description will vary based on the operation's current [CopyStatus](#CopyStatus): - If the operation is *pending*, the description *may* reflect any non-fatal errors which have occurred thus far. - If the operation is *failed*, the description will detail the fatal error which caused the failure. - Otherwise, the description will always be empty. Calling [CopyFile](#azurefilecopyfile-method) will clear this setting; call [GetFileInfo](#azurefilegetfileinfo-method) for the destination file in a copy operation to populate it. **CreateShareQuota**: Specifies an initial space quota to impose when creating shares.This setting may be set to a positive, non-zero integer number to impose a space quota of that many GB when creating shares with [CreateShare](#azurefilecreateshare-method). If set to 0 (default), no explicit space quota is imposed on the share when it is created. Note that a share's space quota may be changed at any time using the [SetShareQuota](#azurefilesetsharequota-method) method. **DeleteShareSnapshots**: Whether to automatically delete share snapshots when deleting a share.This setting specifies whether a share's snapshots (if any exist) should be deleted when the share itself is deleted. If this setting is disabled (default), calling [DeleteShare](#azurefiledeleteshare-method) will fail if the specified share has any snapshots associated with it. **DownloadTempFile**: The temporary file used when downloading encrypted data.This setting specifies the temporary file used when downloading encrypted data. When downloading encrypted data with [LocalFile](#azurefilelocalfile-property) set, the class will automatically create a temporary file at [TempPath](#TempPath) to hold the encrypted file contents. When the download is complete, the data is decrypted to [LocalFile](#azurefilelocalfile-property). If the download is interrupted, the specified file will hold the partially downloaded encrypted file contents. Before resuming the download, this setting must be set to a valid file containing the partially encrypted file contents. See [DownloadFile](#azurefiledownloadfile-method) for details. **EncryptionIV**: The initialization vector to be used for encryption/decryption.When encrypting or decrypting a file, this setting may be set to specify the initialization vector. Normally the class will derive this value automatically from [EncryptionPassword](#azurefileencryptionpassword-property). This setting accepts a hex encoded value. **EncryptionKey**: The key to use during encryption/decryption.When encrypting or decrypting a file, this setting may be set to specify the key to use. Normally the class will derive this value automatically from [EncryptionPassword](#azurefileencryptionpassword-property). This setting accepts a hex encoded value. **EncryptionPasswordKDF**: The KDF algorithm to use during password based encryption and decryption.This setting specified the Key Derivation Function (KDF) used to derive a key from the specified [EncryptionPassword](#azurefileencryptionpassword-property). Possible values are: - 0 (default) - PBKDF1 - 1 - PBKDF2 Note: PBKDF1 is not FIPS compliant. When operating in FIPS mode PBKDF2 should be used. **Endpoint**: The Azure Storage endpoint suffix that the class should use.This setting specifies the base Azure Storage endpoint suffix that the class should use. By default, the class uses the global Azure Storage endpoint, *https://[ACCOUNT].[blob|file]**.core.windows.net*** (this setting controls the bolded suffix only). In most cases, the default endpoint suffix is the correct choice. This setting should only be changed if the class needs to use an endpoint suffix associated with a specific [National Cloud Deployment](https://docs.microsoft.com/en-us/graph/deployments), in which case it should be set to one of the values shown in this table: | National Cloud | Endpoint Suffix | | --- | --- | | Azure global service | .core.windows.net (default) | | Azure Government (US) | .core.usgovcloudapi.net | | Azure Germany | .core.cloudapi.de | | Azure China | .core.chinacloudapi.cn | Please note that each National Cloud Deployment also has its own corresponding application registration portal and OAuth endpoints, both of which are completely separate from those used for/by the global Azure Storage services. Applications that wish to work with a specific National Cloud Deployment must use that National Cloud Deployment's app registration portal and OAuth endpoints to register and authenticate in order for the class to successfully communicate using the National Cloud Deployment-specific endpoint. Refer to Microsoft's [National Cloud Authentication](https://docs.microsoft.com/en-us/azure/active-directory/develop/authentication-national-cloud) article for more information. **MaxResults**: The maximum number of results to return when listing resources or shares.This setting specifies the maximum number of results that should be returned by a call to [ListResources](#azurefilelistresources-method) or [ListShares](#azurefilelistshares-method). If this setting is -1 (default), the server's default (5000) is used. Acceptable values are 1 to 5000 (inclusive). **ProgressAbsolute**: Whether the class should track transfer progress absolutely.This setting controls whether the class tracks upload and download progress absolutely or relatively, with regards to the values reported via the [Progress](#azurefileprogress-event) event when an interrupted transfer is resumed. If this setting is enabled (default), then when a transfer is interrupted and later resumed, the values reported by the [Progress](#azurefileprogress-event) event will account for the data that was successfully transferred before the interruption. If this setting is disabled, then the class will treat resumed transfers as "new" transfers, and the values reported by the [Progress](#azurefileprogress-event) event will start at *0* rather than from the number of bytes already transferred. Refer to the [Progress](#azurefileprogress-event) event for more information. **ProgressStep**: How often the progress event should be fired, in terms of percentage.This setting controls how often the class will fire the [Progress](#azurefileprogress-event) event during an upload or download, in terms of percentage. Valid values are *0* to *99*, inclusive. The default value, *1*, will cause the [Progress](#azurefileprogress-event) event to fire each time the event's *PercentDone* parameter value increases by one percent. Setting this setting to *0* will cause the [Progress](#azurefileprogress-event) event to fire *every* time data is transferred. Note that the [Progress](#azurefileprogress-event) event will *always* fire once at the beginning and end of a transfer, regardless of this setting's value. Also, if *PercentDone* cannot be calculated for a particular transfer (e.g., for downloads that use chunked transfer encoding), then the class will behave as if this setting were *0* for the duration of the transfer. **RawRequest**: Returns the data that was sent to the server.This setting may be queried after calling any method that sends data to the server to obtain the request data that was transmitted. Such data may be useful for troubleshooting purposes. **RawResponse**: Returns the data that was received from the server.This setting may be queried after calling any method that sends data to the server to obtain the response data that was received. Such data may be useful for troubleshooting purposes. **SendMetadata**: Whether to send metadata items when creating files and folders.This setting controls whether the class will automatically submit any [Metadata](#azurefilemetadata-property) items when creating shares or resources with [UploadFile](#azurefileuploadfile-method), [CreateFile](#azurefilecreatefile-method), [CreateFolder](#azurefilecreatefolder-method), or [CreateShare](#azurefilecreateshare-method). By default, this setting is disabled, and resources are not automatically created with metadata. **SendMetadataOnCopy**: Whether to send metadata items when copying files.This setting controls whether the class will automatically submit any [Metadata](#azurefilemetadata-property) items, to apply to the *destination* file, when [CopyFile](#azurefilecopyfile-method) is called. If this setting is disabled (default), or if this setting is enabled but there are no [Metadata](#azurefilemetadata-property) items, then the server will copy the original metadata from the source file to the destination file. **SharedAccessSignature**: Specifies a SAS token to use for authentication.This setting can be used to specify a URL-encoded Shared Access Signature (SAS) token that will be included in the request. To generate a Shared Access Signature for specific resources, you can use the [GetLink](#azurefilegetlink-method) method. **TempPath**: The path to the directory where temporary files are created.This setting specifies the path where temporary files are created when downloading encrypted files. If not specified, the system's temporary directory is used. Refer to [DownloadTempFile](#DownloadTempFile) and [DownloadFile](#azurefiledownloadfile-method) for more information. **XChildCount**: The number of child elements of the current element.This configuration settings specifies the number of child attributes of the current element. The XChild configuration settings will be indexed from 0 to ([XChildCount](#XChildCount) - 1). The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XChildName[i]**: The name of the child element.This configuration setting provides the name of the i-th child element of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XChildXText[i]**: The inner text of the child element.This configuration setting provides the inner text of the i-th child element of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XElement**: The name of the current element.This configuration setting provides the name of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XParent**: The parent of the current element.This configuration setting provides the parent of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XPath**: Provides a way to point to a specific element in the returned XML or JSON response.The [XPath](#XPath) setting allows you to point to specific elements in the XML or JSON response. When [XPath](#XPath) is set to a valid path, [XElement](#XElement) points to the name of the element, with [XText](#XText), [XParent](#XParent), [XSubTree](#XSubTree), [XChildCount](#XChildCount), [XChildName\[i\]](#XChildName[i]), and [XChildXText\[i\]](#XChildXText[i]) providing other properties of the element. XPath syntax is available for both XML and JSON documents. An XPath is a series of one or more element accessors separated by the */* character, for example, */A/B/C/D*. An XPath can be absolute (i.e., it starts with */*), or it can be relative to the current [XPath](#XPath) location. The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors, which proceed it in the overall XPath string: | Accessor | Description | | --- | --- | | name | The first element with a particular name. Can be *. | | [i] | The i-th element. | | name[i] | The i-th element with a particular name. | | [last()] | The last element. | | [last()-i] | The element i before the last element. | | name[@attrname="attrvalue"] | The first element with a particular name that contains the specified attribute-value pair. Supports single and double quotes. (XML Only) | | . | The current element. | | .. | The parent element. | NOTE: XPath indices are *1-based*. For example, assume the following XML and JSON responses. XML: ```text value first second value three ``` JSON: ```text { "firstlevel": { "one": "value", "two": ["first", "second"], "three": "value three" } } ``` The following are examples of valid XPaths for these responses: | Description | XML XPath | JSON XPath | | --- | --- | --- | | Document root | / | /json | | Specific element | /firstlevel/one | /json/firstlevel/one | | i-th child | /firstlevel/two/item[2] | /json/firstlevel/two/[2] | This list is not exhaustive, but it provides a general idea of the possibilities. **XSubTree**: A snapshot of the current element in the document.This configuration setting provides the entirety of the current element (including its subelements). The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XText**: The text of the current element.This configuration setting provides the inner text of the current element. The current element is specified in the [XPath](#XPath) configuration setting. This configuration setting is read-only. ### HTTP Config Settings **AcceptEncoding**: Used to tell the server which types of content encodings the client supports.When [AllowHTTPCompression](#AllowHTTPCompression) is True, the class adds an *Accept-Encoding* header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the *Accept-Encoding* header. NOTE: The class only supports gzip and deflate decompression algorithms. **AllowHTTPCompression**: This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms. When True, the class adds an *Accept-Encoding* header to the outgoing request. The value for this header can be controlled by the [AcceptEncoding](#AcceptEncoding) configuration setting. The default value for this header is "gzip, deflate". The default value is True. **AllowHTTPFallback**: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0". If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class if the server does not support HTTP/2. The default value is True. **Append**: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to [LocalFile](#azurefilelocalfile-property). When set to True, downloaded data will be appended to [LocalFile](#azurefilelocalfile-property). This may be used in conjunction with Range to resume a failed download. This is applicable only when [LocalFile](#azurefilelocalfile-property) is set. The default value is False. **Authorization**: The Authorization string to be sent to the server.If the [Authorization](#Authorization) property contains a nonempty string, an *Authorization* HTTP request header is added to the request. This header conveys Authorization information to the server. This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class. The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the [Authorization](#azurefileauthorization-property) property in the form "Basic [encoded-user-password]". **BytesTransferred**: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the [Transfer](#azurefiletransfer-event) event, by [BytesTransferred](#BytesTransferred). **ChunkSize**: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when [UseChunkedEncoding](#UseChunkedEncoding) is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384. **CompressHTTPRequest**: Set to true to compress the body of a PUT or POST request.If set to True, the body of a *PUT* or *POST* request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request. The default value is False. **EncodeURL**: If set to True the URL will be encoded by the class.If set to True, the URL passed to the class will be URL encoded. The default value is False. **FollowRedirects**: Determines what happens when the server issues a redirect.This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time. If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class . **Note:** Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for *GET* or *HEAD* requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities. Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server. A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters). The default value is 0 (Never). In this case, redirects are never followed, and the class instead. Following are the valid options: - 0 - Never - 1 - Always - 2 - Same Scheme **GetOn302Redirect**: If set to True the class will perform a GET on the new location.The default value is False. If set to True, the class will perform a *GET* on the new location. Otherwise, it will use the same HTTP method again. **HTTP2HeadersWithoutIndexing**: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names. **HTTPVersion**: The version of HTTP used by the class.This property specifies the HTTP version used by the class. Possible values are as follows: - "1.0" - "1.1" (default) - "2.0" - "3.0" When using HTTP/2 ("2.0") or HTTP/3 ("3.0"), additional restrictions apply. Please see the following notes for details. **HTTP/2 Notes** When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error. If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) after calling a method. The [AllowHTTPFallback](#AllowHTTPFallback) setting controls whether this behavior is allowed (default) or disallowed. **HTTP/3 Notes** HTTP/3 is supported only in .NET and Java. When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error. **IfModifiedSince**: A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: ```text Sat, 29 Oct 2017 19:43:31 GMT. ``` **KeepAlive**: Determines whether the HTTP connection is closed after completion of the request.If *true*, the component will not send the *Connection: Close* header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. NOTE: Not all servers support persistent connections. If *false*, the connection will be closed immediately after the server response is received. The default value for [KeepAlive](#KeepAlive) is *false*. **KerberosSPN**: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here. **LogLevel**: The level of detail that is logged.This configuration setting controls the level of detail that is logged through the [Log](#azurefilelog-event) event. Possible values are as follows: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data are logged. | | 3 (Debug) | Debug data are logged. | The value 1 (Info) logs basic information, including the URL, HTTP version, and status details. The value 2 (Verbose) logs additional information about the request and response. The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any). **MaxRedirectAttempts**: Limits the number of redirects that are followed in a request.When FollowRedirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20. **NegotiatedHTTPVersion**: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used. **OtherHeaders**: Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers. The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by . Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail. This configuration setting is useful for extending the functionality of the class beyond what is provided. **ProxyAuthorization**: The authorization string to be sent to the proxy server.This is similar to the [Authorization](#Authorization) configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a *Proxy-Authorization* HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If ProxyUser and ProxyPassword are specified, this value is calculated using the algorithm specified by ProxyAuthScheme. **ProxyAuthScheme**: The authorization scheme to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyPassword**: A password if authentication is to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyPort**: Port for the proxy server (default 80).This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyServer**: Name or IP address of a proxy server (optional).This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyUser**: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties. **SentHeaders**: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client. **StatusCode**: The status code of the last response from the server.This configuration setting contains the result code of the last response from the server. **StatusLine**: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be *[HTTP version] [Result Code] [Description]*. **TransferredData**: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server. **TransferredDataLimit**: The maximum number of incoming bytes to be stored by the class.If [TransferredDataLimit](#TransferredDataLimit) is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class. **TransferredHeaders**: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server. **TransferredRequest**: The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request: .NET ```text Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); ``` C++ ```text HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest")); ``` **UseChunkedEncoding**: Enables or Disables HTTP chunked encoding for transfers.If [UseChunkedEncoding](#UseChunkedEncoding) is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False. NOTE: Some servers (such as the ASP.NET Development Server) may not support chunked encoding. **UseIDNs**: Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name). The default value is False and the hostname will always be used exactly as specified. NOTE: The [CodePage](#CodePage) setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set [CodePage](#CodePage) to *65001*. **UseProxyAutoConfigURL**: Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and ProxyAutoDetect is set to *True*. When *True* (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use. **UserAgent**: Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com". Override the default with the name and version of your software. ### TCPClient Config Settings **ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use [Timeout](#azurefiletimeout-property) for establishing a connection and transmitting/receiving data. **FirewallAutoDetect**: Tells the class whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by classes that do not directly expose Firewall properties. **FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting. If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned. NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting. **FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the class . NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value. NOTE: This configuration setting is provided for use by classes that do not directly expose Firewall properties. **FirewallType**: Determines the type of firewall to connect through.Possible values are as follows: | | | | --- | --- | | 0 | No firewall (default setting). | | 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. | | 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. | NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the class . NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second. NOTE: This value is not applicable in macOS. **KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. **Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True. In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action. **LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. **LocalHost**: The name of the local host through which connections are initiated or accepted. The [LocalHost](#azurefilelocalhost-property) setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface. If the class is connected, the [LocalHost](#azurefilelocalhost-property) setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). **LocalPort**: The port in the local host where the class binds. This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established. LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems. **MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an EOL string. If an EOL string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the DataIn event is fired with the *EOL* parameter set to True, and the buffer is reset. If no EOL is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the DataIn event is fired with the *EOL* parameter set to False, and the buffer is reset. The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes. **MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. **ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance: *www.google.com;www.example.com* **TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets. NOTE: This value is not applicable in Java. **TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this configuration setting is set to False. **UseIPv6**: Whether to use IPv6.When set to *0* (default), the class will use IPv4 exclusively. When set to *1*, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows: | | | | --- | --- | | 0 | IPv4 only | | 1 | IPv6 only | | 2 | IPv6 with IPv4 fallback | **UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1. ### SSL Config Settings **LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [SSLProvider](#azurefilesslprovider-property) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes. When enabled, SSL packet logs are output using the [SSLStatus](#azurefilesslstatus-event) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if [SSLProvider](#azurefilesslprovider-property) is set to *Platform*. **OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL. The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL. The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences: -----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE----- Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL. The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH". **OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL. By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG. **ReuseSSLSession**: Determines if the SSL session is reused. If set to True, the class will reuse the context if and only if the following criteria are met: - The target host name is the same. - The system cache entry has not expired (default timeout is 10 hours). - The application process that calls the function is the same. - The logon session is the same. - The instance of the class is the same. **SSLAcceptAnyServerCert**: Whether to trust any certificate presented by the server.This configuration setting disables all certificate verification when set to *True*. This configuration setting must be enabled to trust a self-signed certificate. It is not recommended to enable this configuration setting in a production environment. The default value is False. **SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#azurefilesslprovider-property) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the [SSLCert](#azurefilesslcert-property) property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated. NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [SSLStatus](#azurefilesslstatus-event) event. Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting. **SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation. By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the class will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Example values when [SSLProvider](#azurefilesslprovider-property) is set to *Platform* include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); ``` Possible values when [SSLProvider](#azurefilesslprovider-property) is set to *Platform* include the following: - CALG_3DES - CALG_3DES_112 - CALG_AES - CALG_AES_128 - CALG_AES_192 - CALG_AES_256 - CALG_AGREEDKEY_ANY - CALG_CYLINK_MEK - CALG_DES - CALG_DESX - CALG_DH_EPHEM - CALG_DH_SF - CALG_DSS_SIGN - CALG_ECDH - CALG_ECDH_EPHEM - CALG_ECDSA - CALG_ECMQV - CALG_HASH_REPLACE_OWF - CALG_HUGHES_MD5 - CALG_HMAC - CALG_KEA_KEYX - CALG_MAC - CALG_MD2 - CALG_MD4 - CALG_MD5 - CALG_NO_SIGN - CALG_OID_INFO_CNG_ONLY - CALG_OID_INFO_PARAMETERS - CALG_PCT1_MASTER - CALG_RC2 - CALG_RC4 - CALG_RC5 - CALG_RSA_KEYX - CALG_RSA_SIGN - CALG_SCHANNEL_ENC_KEY - CALG_SCHANNEL_MAC_KEY - CALG_SCHANNEL_MASTER_HASH - CALG_SEAL - CALG_SHA - CALG_SHA1 - CALG_SHA_256 - CALG_SHA_384 - CALG_SHA_512 - CALG_SKIPJACK - CALG_SSL2_MASTER - CALG_SSL3_MASTER - CALG_SSL3_SHAMD5 - CALG_TEK - CALG_TLS1_MASTER - CALG_TLS1PRF Example values when [SSLProvider](#azurefilesslprovider-property) is set to *Internal*include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA"); ``` Possible values when [SSLProvider](#azurefilesslprovider-property) is set to *Internal* include the following: - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_DSS_WITH_AES_256_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 - TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 - TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA - TLS_DHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA - TLS_DHE_DSS_WITH_AES_256_CBC_SHA - TLS_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_DSS_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_DES_CBC_SHA - TLS_DHE_RSA_WITH_DES_CBC_SHA - TLS_DHE_DSS_WITH_DES_CBC_SHA - TLS_RSA_WITH_RC4_128_MD5 - TLS_RSA_WITH_RC4_128_SHA When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength). **SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols. Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values: | | | | --- | --- | | TLS1.3 | 12288 (Hex 3000) | | TLS1.2 | 3072 (Hex C00) (Default - Client and Server) | | TLS1.1 | 768 (Hex 300) (Default - Client) | | TLS1 | 192 (Hex C0) (Default - Client) | | SSL3 | 48 (Hex 30) | | SSL2 | 12 (Hex 0C) | Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases. **SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:** In the JavaScript edition, the platform implementation is used when TLS 1.3 is enabled and [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported. **SSLEnabledProtocols: SSL2 and SSL3 Notes: ** SSL 2.0 and 3.0 are not supported by the class when the [SSLProvider](#azurefilesslprovider-property) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [SSLProvider](#azurefilesslprovider-property) needs to be set to platform. **SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *false* by default, but it can be set to *true* to enable the extension. This configuration setting is applicable only when [SSLProvider](#azurefilesslprovider-property) is set to *Internal*. **SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [SSLServerAuthentication](#azurefilesslserverauthentication-event) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [SSLServerAuthentication](#azurefilesslserverauthentication-event) event. If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#azurefilesslserverauthentication-event) event. This includes the leaf certificate, any intermediate certificate, and the root certificate. **SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values. NOTE: This configuration setting is applicable only when [SSLProvider](#azurefilesslprovider-property) is set to *Internal*. **SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipher[connId]"); ``` **SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherStrength[connId]"); ``` **SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherSuite[connId]"); ``` **SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchange[connId]"); ``` **SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchangeStrength[connId]"); ``` **SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedVersion[connId]"); ``` **SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions: | | | | --- | --- | | 0x00000001 | Ignore time validity status of certificate. | | 0x00000002 | Ignore time validity status of CTL. | | 0x00000004 | Ignore non-nested certificate times. | | 0x00000010 | Allow unknown certificate authority. | | 0x00000020 | Ignore wrong certificate usage. | | 0x00000100 | Ignore unknown certificate revocation status. | | 0x00000200 | Ignore unknown CTL signer revocation status. | | 0x00000400 | Ignore unknown certificate authority revocation status. | | 0x00000800 | Ignore unknown root revocation status. | | 0x00008000 | Allow test root certificate. | | 0x00004000 | Trust test root certificate. | | 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). | This functionality is currently not available when the provider is OpenSSL. **SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [SSLProvider](#azurefilesslprovider-property) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2. When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class . The format of this value is a comma-separated list of hash-signature combinations. For instance: ```csharp component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); ``` The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*. To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. **TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC. The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*. When using TLS 1.2 and [SSLProvider](#azurefilesslprovider-property) is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported: - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) **TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server. The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting. NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group. In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" - "ffdhe_6144" - "ffdhe_8192" **TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following: - "ed25519" (default) - "ed448" (default) - "ecdsa_secp256r1_sha256" (default) - "ecdsa_secp384r1_sha384" (default) - "ecdsa_secp521r1_sha512" (default) - "rsa_pkcs1_sha256" (default) - "rsa_pkcs1_sha384" (default) - "rsa_pkcs1_sha512" (default) - "rsa_pss_sha256" (default) - "rsa_pss_sha384" (default) - "rsa_pss_sha512" (default) The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3. **TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" (default) - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" (default) - "ffdhe_6144" (default) - "ffdhe_8192" (default) - "mlkem_512" (default) - "mlkem_768" (default) - "mlkem_1024" (default) - "x25519_mlkem_768" (default) - "secp256r1_mlkem_768" (default) Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported: - Windows Server 2025 - Windows 11 24H2 - Windows 11 25H2 ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [Timeout](#azurefiletimeout-property) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout. NOTE: This option is not valid for User Datagram Protocol (UDP) ports. **FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes). **InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries. This setting is set to *false* by default on all platforms. # Trappable Errors (*class *cloudstorage.[azurefile](#azurefile-class)) ### Common Errors | | | | --- | --- | | 600 | A server error occurred, and/or the class was unable to process the server's response. Please refer to the error message for more information. | | 601 | An unsupported operation or action was attempted. | | 602 | The [RawRequest](#RawRequest) or [RawResponse](#RawResponse) configuration setting was queried without first setting the TransferredRequest configuration setting to ON. | | 603 | The login credentials specified were invalid. Please refer to the error message for more information. | | 604 | An invalid remote resource identifier (i.e., a name, path, Id, etc.) was specified. | | 605 | An invalid index was specified. | | 606 | An upload was aborted by the user before it could finish. | | 607 | The specified resource is a folder and cannot be downloaded. | | 608 | A download failed because the specified [LocalFile](#azurefilelocalfile-property) already exists and [Overwrite](#azurefileoverwrite-property) is false. | | 609 | The class could not resume a download or upload. Please refer to the error message for more information. | | 610 | An encrypted download could not be resumed because the [DownloadTempFile](#DownloadTempFile) configuration setting is not set. | | 611 | An exception occurred while working with the specified [LocalFile](#azurefilelocalfile-property) (or the current value of [LocalFile](#azurefilelocalfile-property) is invalid). Please refer to the error message for more information. | | 612 | An exception occurred while working with the specified upload or download stream. Please refer to the error message for more information. | ### HTTP Errors | | | | --- | --- | | 118 | Firewall error. The error description contains the detailed message. | | 143 | Busy executing current method. | | 151 | HTTP protocol error. The error message has the server response. | | 152 | No server specified in URL. | | 153 | Specified URLScheme is invalid. | | 155 | Range operation is not supported by server. | | 156 | Invalid cookie index (out of range). | | 301 | Interrupted. | | 302 | Cannot open AttachedFile. | ### TCPClient Errors | | | | --- | --- | | 100 | You cannot change the RemotePort at this time. A connection is in progress. | | 101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. | | 102 | The RemoteHost address is invalid (0.0.0.0). | | 104 | Already connected. If you want to reconnect, close the current connection first. | | 106 | You cannot change the LocalPort at this time. A connection is in progress. | | 107 | You cannot change the [LocalHost](#azurefilelocalhost-property) at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | RemotePort cannot be zero. Please specify a valid service port number. | | 117 | You cannot change the UseConnection option while the class is active. | | 135 | Operation would block. | | 201 | Timeout. | | 211 | Action impossible in control's present state. | | 212 | Action impossible while not connected. | | 213 | Action impossible while listening. | | 301 | Timeout. | | 302 | Could not open file. | | 434 | Unable to convert string to selected CodePage. | | 1105 | Already connecting. If you want to reconnect, close the current connection first. | | 1117 | You need to connect first. | | 1119 | You cannot change the LocalHost at this time. A connection is in progress. | | 1120 | Connection dropped by remote host. | ### SSL Errors | | | | --- | --- | | 270 | Cannot load specified security library. | | 271 | Cannot open certificate store. | | 272 | Cannot find specified certificate. | | 273 | Cannot acquire security credentials. | | 274 | Cannot find certificate chain. | | 275 | Cannot verify certificate chain. | | 276 | Error during handshake. | | 280 | Error verifying certificate. | | 281 | Could not find client certificate. | | 282 | Could not find server certificate. | | 283 | Error encrypting data. | | 284 | Error decrypting data. | ### TCP/IP Errors | | | | --- | --- | | 10004 | [10004] Interrupted system call. | | 10009 | [10009] Bad file number. | | 10013 | [10013] Access denied. | | 10014 | [10014] Bad address. | | 10022 | [10022] Invalid argument. | | 10024 | [10024] Too many open files. | | 10035 | [10035] Operation would block. | | 10036 | [10036] Operation now in progress. | | 10037 | [10037] Operation already in progress. | | 10038 | [10038] Socket operation on nonsocket. | | 10039 | [10039] Destination address required. | | 10040 | [10040] Message is too long. | | 10041 | [10041] Protocol wrong type for socket. | | 10042 | [10042] Bad protocol option. | | 10043 | [10043] Protocol is not supported. | | 10044 | [10044] Socket type is not supported. | | 10045 | [10045] Operation is not supported on socket. | | 10046 | [10046] Protocol family is not supported. | | 10047 | [10047] Address family is not supported by protocol family. | | 10048 | [10048] Address already in use. | | 10049 | [10049] Cannot assign requested address. | | 10050 | [10050] Network is down. | | 10051 | [10051] Network is unreachable. | | 10052 | [10052] Net dropped connection or reset. | | 10053 | [10053] Software caused connection abort. | | 10054 | [10054] Connection reset by peer. | | 10055 | [10055] No buffer space available. | | 10056 | [10056] Socket is already connected. | | 10057 | [10057] Socket is not connected. | | 10058 | [10058] Cannot send after socket shutdown. | | 10059 | [10059] Too many references, cannot splice. | | 10060 | [10060] Connection timed out. | | 10061 | [10061] Connection refused. | | 10062 | [10062] Too many levels of symbolic links. | | 10063 | [10063] File name is too long. | | 10064 | [10064] Host is down. | | 10065 | [10065] No route to host. | | 10066 | [10066] Directory is not empty | | 10067 | [10067] Too many processes. | | 10068 | [10068] Too many users. | | 10069 | [10069] Disc Quota Exceeded. | | 10070 | [10070] Stale NFS file handle. | | 10071 | [10071] Too many levels of remote in path. | | 10091 | [10091] Network subsystem is unavailable. | | 10092 | [10092] WINSOCK DLL Version out of range. | | 10093 | [10093] Winsock is not loaded yet. | | 11001 | [11001] Host not found. | | 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). | | 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. | | 11004 | [11004] Valid name, no data record (check DNS setup). |