AzureFile Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

nsoftware.CloudStorage.AzureFile

Remarks

The AzureFile component offers an easy-to-use API for the Microsoft Azure File Storage service. Capabilities include uploading and downloading files, strong encryption support, creating folders, file manipulation, and more.

Authentication

Authentication is simple, set the Account property to the name of the Azure Storage account to operate against, and set the AccessKey property to an Azure access key associated with that account.

Addressing Resources

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

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

Listing Directory Contents

ListResources lists resources (files and folders) within the specified directory. Calling this method will fire the ResourceList event once for each resource, and will also populate the Resources collection. // ResourceList event handler. azurefile.OnResourceList += (s, e) => { Console.WriteLine(e.Name); }; azurefile.Share = "myshare"; do { azurefile.ListResources("/work_files/serious_business/cats"); for (int i = 0; i < azurefile.Resources.Count; i++) { // Process resources here. } } while (!string.IsNullOrEmpty(azurefile.ResourceMarker));

Downloading Files

The DownloadFile method downloads files.

If a stream has been specified using SetDownloadStream, the file data will be sent through it. If a stream is not specified, and LocalFile is set, the file will be saved to the specified location; otherwise, the file data will be held by ResourceData.

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

Download Notes

In the simplest use-case, downloading a file looks like this: azurefile.LocalFile = "../MyFile.zip"; azurefile.DownloadFile(azurefile.Resources[0].Path);

Resuming Downloads

The component also supports resuming failed downloads by using the StartByte property. If a download is interrupted, set StartByte to the appropriate offset before calling this method to resume the download. string downloadFile = "../MyFile.zip"; azurefile.LocalFile = downloadFile; azurefile.DownloadFile(azurefile.Resources[0].Path); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially downloaded file azurefile.StartByte = new FileInfo(downloadFile).Length; azurefile.DownloadFile(azurefile.Resources[0].Path);

Resuming Encrypted File Downloads

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

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

To resume, DownloadTempFile must be populated, along with StartByte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to LocalFile. azurefile.LocalFile = "../MyFile.zip"; azurefile.EncryptionPassword = "password"; azurefile.DownloadFile(azurefile.Resources[0].Path); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially download temp file azurefile.StartByte = new FileInfo(azurefile.Config("DownloadTempFile")).Length; azurefile.DownloadFile(azurefile.Resources[0].Path);

Uploading Files

The UploadFile method uploads new files.

If SetUploadStream has been used to set an upload stream, it will take priority as the file data source. If LocalFile is set the file will be uploaded from the specified path. If LocalFile is not set the data in ResourceData will be used.

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

Upload Notes

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

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

If the upload is interrupted for any reason, resuming it is easy. First, verify that StartByte is populated (if the same instance of the component is used, they should already be populated, and no special action should be needed). If uploading from a stream, be sure to reset its position to where it was the first time the upload was started (typically the beginning). Then call UploadFile again to resume the upload at the specified StartByte offset. azurefile.LocalFile = "../MyFile.zip"; azurefile.UploadFile("MyFile.zip"); //The transfer is interrupted and UploadFile() above fails. Later, resume the download. //Using the same instance StartByte is already populated from the previous upload attempt. azurefile.UploadFile("MyFile.zip"); MemoryStream uploadStream = new MemoryStream(File.ReadAllBytes("../MyFile.zip")); azurefile.SetUploadStream(uploadStream); azurefile.UploadFile("MyFile.zip"); //The transfer is interrupted and UploadFile() above fails. Later, resume the download. //Using the same instance StartByte is already populated from the previous upload attempt. //You MUST reset the stream's position to where it was when you first started the upload! uploadStream.Position = 0; azurefile.UploadFile("MyFile.zip");

Additional Functionality

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

• Encrypt and decrypt files using the EncryptionAlgorithm and EncryptionPassword properties.
• Basic file and folder manipulation and organization using methods such as CreateFolder, CopyFile, DeleteFolder, and DeleteFile.
• Advanced file manipulation with CreateFile, ResizeFile, PutRange, GetRanges, and ClearRange.
• Share manipulation with CreateShare, SetShareQuota, and DeleteShare.
• Retrieval of information and metadata for files, folders, and shares using GetFileInfo, GetFolderInfo, and GetShareInfo.
• And more!

Property List

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

Method List

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

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

AccessKey Property (AzureFile Component)

The Azure access key to use for authentication.

Syntax

• C#
• VB.NET

public string AccessKey { get; set; }

Public Property AccessKey As String

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.

Account Property (AzureFile Component)

The Azure storage account name.

Syntax

• C#
• VB.NET

public string Account { get; set; }

Public Property Account As String

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.

Authorization Property (AzureFile Component)

OAuth 2.0 Authorization Token

Syntax

• C#
• VB.NET

public string Authorization { get; set; }

Public Property Authorization As String

Default Value

""

Remarks

This component supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth property, using the OAuth component or a separate process. If using the OAuth property, then the Authorization property will not be used.

Bearer ACCESS_TOKEN

TBD.

EncryptionAlgorithm Property (AzureFile Component)

The encryption algorithm.

Syntax

• C#
• VB.NET

public AzureFileEncryptionAlgorithms EncryptionAlgorithm { get; set; }

enum AzureFileEncryptionAlgorithms {
  eaAES,
  eaBlowfish,
  eaCAST,
  eaDES,
  eaIDEA,
  eaRC2,
  eaRC4,
  eaTEA,
  eaTripleDES,
  eaTwofish,
  eaRijndael,
  eaChaCha,
  eaXSalsa20
}

Public Property EncryptionAlgorithm As AzurefileEncryptionAlgorithms

Enum AzureFileEncryptionAlgorithms
  eaAES
  eaBlowfish
  eaCAST
  eaDES
  eaIDEA
  eaRC2
  eaRC4
  eaTEA
  eaTripleDES
  eaTwofish
  eaRijndael
  eaChaCha
  eaXSalsa20
End Enum

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:

EncryptionPassword Property (AzureFile Component)

The encryption password.

Syntax

• C#
• VB.NET

public string EncryptionPassword { get; set; }

Public Property EncryptionPassword As String

Default Value

""

Remarks

If this property is populated when UploadFile or DownloadFile is called, the component will attempt to encrypt or decrypt the data before uploading or after downloading it.

The component 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 and 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.

Firewall Property (AzureFile Component)

A set of properties related to firewall access.

Syntax

• C#
• VB.NET

public Firewall Firewall { get; set; }

Public Property Firewall As Firewall

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.

Idle Property (AzureFile Component)

The current status of the component.

Syntax

• C#
• VB.NET

public bool Idle { get; }

Public ReadOnly Property Idle As 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.

LocalFile Property (AzureFile Component)

The location of the local file.

Syntax

• C#
• VB.NET

public string LocalFile { get; set; }

Public Property LocalFile As String

Default Value

""

Remarks

This property specifies the location of a file on disk. This is used as the source file when calling UploadFile or PutRange, and as the destination file when calling DownloadFile.

Note that if SetUploadStream or SetDownloadStream is called, the specified stream will be used instead of the file set here.

LocalHost Property (AzureFile Component)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C#
• VB.NET

public string LocalHost { get; set; }

Public Property LocalHost As String

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 component initiate connections (or accept in the case of server components) 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 component 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.

Metadata Property (AzureFile Component)

A collection of metadata items.

Syntax

• C#
• VB.NET

public AzureMetadataList Metadata { get; }

Public Property Metadata As AzureMetadataList

Remarks

This collection holds a list of metadata items.

This collection is populated anytime one of GetFileInfo, GetFolderInfo, or GetShareInfo is called.

The items in this collection may be used by some of the following methods: UpdateMetadata, UploadFile, CreateFile, CopyFile, and CreateFolder.

This property is not available at design time.

OAuth Property (AzureFile Component)

This property holds the OAuth Settings.

Syntax

• C#
• VB.NET

public OAuthSettings OAuth { get; }

Public ReadOnly Property OAuth As OAuthSettings

Remarks

This property is used to define 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.

OtherHeaders Property (AzureFile Component)

Other headers as determined by the user (optional).

Syntax

• C#
• VB.NET

public string OtherHeaders { get; set; }

Public Property OtherHeaders As String

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 CRLF ("\r\n") .

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 component beyond what is provided.

This property is not available at design time.

Overwrite Property (AzureFile Component)

Determines if files are overwritten.

Syntax

• C#
• VB.NET

public bool Overwrite { get; set; }

Public Property Overwrite As Boolean

Default Value

False

Remarks

This property controls whether local files are overwritten when calling DownloadFile or remote files are renamed when calling RenameFile. The default value is false.

ParsedHeaders Property (AzureFile Component)

This property includes a collection of headers returned from the last request.

Syntax

• C#
• VB.NET

public HeaderList ParsedHeaders { get; }

Public ReadOnly Property ParsedHeaders As HeaderList

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 in this collection contains information describing that header.

MaxHeaders can be used to control the maximum number of headers saved.

This collection is indexed from 0 to count -1.

This property is read-only and not available at design time.

Prefix Property (AzureFile Component)

A prefix used to restrict the results returned when listing resources or shares.

Syntax

• C#
• VB.NET

public string Prefix { get; set; }

Public Property Prefix As String

Default Value

""

Remarks

This property, if non-empty, is used to restrict the results returned by ListResources or ListShares to only the items whose names begin with the given value.

This property is not available at design time.

Proxy Property (AzureFile Component)

A set of properties related to proxy access.

Syntax

• C#
• VB.NET

public Proxy Proxy { get; set; }

Public Property Proxy As Proxy

Remarks

This property contains fields describing the proxy through which the component will attempt to connect.

QueryParams Property (AzureFile Component)

Additional query parameters to be included in the request.

Syntax

• C#
• VB.NET

public QueryParamList QueryParams { get; }

Public Property QueryParams As QueryParamList

Remarks

This is a collection of query parameters that will be added to the request. Parameters can be added via the AddQueryParam method.

Ranges Property (AzureFile Component)

A collection of byte ranges.

Syntax

• C#
• VB.NET

public AzureRangeList Ranges { get; }

Public ReadOnly Property Ranges As AzureRangeList

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.

ResourceData Property (AzureFile Component)

The data that was downloaded, or that should be uploaded.

Syntax

• C#
• VB.NET

public string ResourceData { get; set; }
public byte[] ResourceDataB { get; set; }

Public Property ResourceData As String
Public Property ResourceDataB As Byte()

Default Value

""

Remarks

This property is populated with file data after calling DownloadFile if SetDownloadStream and LocalFile are not set.

This property can also be set before calling UploadFile; its data will be uploaded if SetUploadStream and LocalFile are not set.

This property is not available at design time.

ResourceMarker Property (AzureFile Component)

A marker indicating what page of resources to return next.

Syntax

• C#
• VB.NET

public string ResourceMarker { get; set; }

Public Property ResourceMarker As String

Default Value

""

Remarks

This property will be populated when ListResources is called if the results are paged and there are more pages. To list all resources, continue to call ListResources until this property returns empty string.

Refer to ListResources for more information.

This property is not available at design time.

Resources Property (AzureFile Component)

A collection of resources.

Syntax

• C#
• VB.NET

public AzureFileResourceList Resources { get; }

Public ReadOnly Property Resources As AzureFileResourceList

Remarks

This collection holds a list of file and folder resources.

Calling ListResources or GetResourceInfo will populate this collection.

This property is read-only and not available at design time.

Share Property (AzureFile Component)

Selects a share.

Syntax

• C#
• VB.NET

public string Share { get; set; }

Public Property Share As String

Default Value

""

Remarks

This property selects a share, by name, for the component 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 component 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.

ShareMarker Property (AzureFile Component)

A marker indicating what page of shares to return next.

Syntax

• C#
• VB.NET

public string ShareMarker { get; set; }

Public Property ShareMarker As String

Default Value

""

Remarks

This property will be populated when ListShares is called if the results are paged and there are more pages. To list all shares, continue to call ListShares until this property returns empty string.

Refer to ListShares for more information.

This property is not available at design time.

Shares Property (AzureFile Component)

A collection of shares.

Syntax

• C#
• VB.NET

public AzureFileShareList Shares { get; }

Public ReadOnly Property Shares As AzureFileShareList

Remarks

This collection holds a list of shares.

Calling ListShares or GetShareInfo will populate this collection.

This property is read-only and not available at design time.

SSLAcceptServerCert Property (AzureFile Component)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C#
• VB.NET

public Certificate SSLAcceptServerCert { get; set; }

Public Property SSLAcceptServerCert As Certificate

Remarks

If it finds any issues with the certificate presented by the server, the component 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.

SSLCert Property (AzureFile Component)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C#
• VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

This property includes the digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLProvider Property (AzureFile Component)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

• C#
• VB.NET

public AzureFileSSLProviders SSLProvider { get; set; }

enum AzureFileSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As AzurefileSSLProviders

Enum AzureFileSSLProviders
  sslpAutomatic
  sslpPlatform
  sslpInternal
End Enum

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 component 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:

In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.

When Automatic is selected, on Windows, the component will use the platform implementation. On Linux/macOS, the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

The .NET Standard library will always use the internal implementation on all platforms.

SSLServerCert Property (AzureFile Component)

The server certificate for the last established connection.

Syntax

• C#
• VB.NET

public Certificate SSLServerCert { get; }

Public ReadOnly Property SSLServerCert As Certificate

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.

StartByte Property (AzureFile Component)

The byte offset from which to start the upload or download.

Syntax

• C#
• VB.NET

public long StartByte { get; set; }

Public Property StartByte As Long

Default Value

0

Remarks

This property may be set to resume an upload or download; it specifies the offset in the file (or stream, when uploading) from which to resume. See UploadFile and DownloadFile for details about resuming uploads and downloads.

When uploading from a stream, the component will always seek forward in the stream if the value of StartByte is greater than 0 when UploadFile is called. Keep this in mind when resuming interrupted uploads.

This property is not available at design time.

Timeout Property (AzureFile Component)

The timeout for the component.

Syntax

• C#
• VB.NET

public int Timeout { get; set; }

Public Property Timeout As Integer

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 component will wait for the operation to complete before returning control.

The component 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 component throws an exception.

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.

UseSSL Property (AzureFile Component)

Whether to use SSL/TLS when connecting.

Syntax

• C#
• VB.NET

public bool UseSSL { get; set; }

Public Property UseSSL As Boolean

Default Value

True

Remarks

This property specifies whether the component should use SSL/TLS when connecting.

This property is not available at design time.

AbortCopy Method (AzureFile Component)

Aborts a copy operation.

Syntax

• C#
• VB.NET

public void AbortCopy(string destFilePath, string copyId);

Async Version
public async Task AbortCopy(string destFilePath, string copyId);
public async Task AbortCopy(string destFilePath, string copyId, CancellationToken cancellationToken);

Public Sub AbortCopy(ByVal DestFilePath As String, ByVal CopyId As String)

Async Version
Public Sub AbortCopy(ByVal DestFilePath As String, ByVal CopyId As String) As Task
Public Sub AbortCopy(ByVal DestFilePath As String, ByVal CopyId As String, cancellationToken As CancellationToken) As Task

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.

Note that the destination file will still exist after aborting a copy operation, but it will be empty.

AddMetadata Method (AzureFile Component)

Adds a metadata item to the Metadata properties.

Syntax

• C#
• VB.NET

public void AddMetadata(string name, string value);

Async Version
public async Task AddMetadata(string name, string value);
public async Task AddMetadata(string name, string value, CancellationToken cancellationToken);

Public Sub AddMetadata(ByVal Name As String, ByVal Value As String)

Async Version
Public Sub AddMetadata(ByVal Name As String, ByVal Value As String) As Task
Public Sub AddMetadata(ByVal Name As String, ByVal Value As String, cancellationToken As CancellationToken) As Task

Remarks

This method adds a metadata item to the Metadata collection. Name specifies the name of the item, and Value specifies the value of the item.

Note that the component 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.

AddQueryParam Method (AzureFile Component)

Adds a query parameter to the QueryParams properties.

Syntax

• C#
• VB.NET

public void AddQueryParam(string name, string value);

Async Version
public async Task AddQueryParam(string name, string value);
public async Task AddQueryParam(string name, string value, CancellationToken cancellationToken);

Public Sub AddQueryParam(ByVal Name As String, ByVal Value As String)

Async Version
Public Sub AddQueryParam(ByVal Name As String, ByVal Value As String) As Task
Public Sub AddQueryParam(ByVal Name As String, ByVal Value As String, cancellationToken As CancellationToken) As Task

Remarks

This method is used to add a query parameter to the QueryParams collection. Name specifies the name of the parameter, and Value specifies the value of the parameter.

All specified Values will be URL encoded by the component automatically. Consult the service documentation for details on the available parameters.

Authorize Method (AzureFile Component)

Get the authorization string required to access the protected resource.

Syntax

• C#
• VB.NET

public void Authorize();

Async Version
public async Task Authorize();
public async Task Authorize(CancellationToken cancellationToken);

Public Sub Authorize()

Async Version
Public Sub Authorize() As Task
Public Sub Authorize(cancellationToken As CancellationToken) As Task

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 ClientProfile field and the GrantType field. This method is not to be used in conjunction with the Authorization property. It should instead be used when setting the OAuth property.

For more information, see the introduction section.

ClearRange Method (AzureFile Component)

Clears a range of bytes from a file.

Syntax

• C#
• VB.NET

public void ClearRange(string filePath, long first, long last);

Async Version
public async Task ClearRange(string filePath, long first, long last);
public async Task ClearRange(string filePath, long first, long last, CancellationToken cancellationToken);

Public Sub ClearRange(ByVal FilePath As String, ByVal First As Long, ByVal Last As Long)

Async Version
Public Sub ClearRange(ByVal FilePath As String, ByVal First As Long, ByVal Last As Long) As Task
Public Sub ClearRange(ByVal FilePath As String, ByVal First As Long, ByVal Last As Long, cancellationToken As CancellationToken) As Task

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.

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.

Config Method (AzureFile Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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, you must call Config("PROPERTY"). The value will be returned as a string.

CopyFile Method (AzureFile Component)

Copies a file.

Syntax

• C#
• VB.NET

public string CopyFile(string fromFilePath, string toFilePath, string toShare);

Async Version
public async Task<string> CopyFile(string fromFilePath, string toFilePath, string toShare);
public async Task<string> CopyFile(string fromFilePath, string toFilePath, string toShare, CancellationToken cancellationToken);

Public Function CopyFile(ByVal FromFilePath As String, ByVal ToFilePath As String, ByVal ToShare As String) As String

Async Version
Public Function CopyFile(ByVal FromFilePath As String, ByVal ToFilePath As String, ByVal ToShare As String) As Task(Of String)
Public Function CopyFile(ByVal FromFilePath As String, ByVal ToFilePath As String, ByVal ToShare As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

This method copies the file at FromFilePath (in the share currently selected by Share) 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 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 and CopyStatus configuration settings (and clear CopyProgress and 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 method to poll the destination file's information, which will cause the CopyStatus, CopyStatusDesc, and CopyProgress configuration settings to be refreshed.

A copy operation whose CopyStatus is still pending may also be aborted by passing the copy operation Id returned by this method (or later retrieved from CopyId) to the AbortCopy method. // 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"); }

CreateFile Method (AzureFile Component)

Initializes a new file.

Syntax

• C#
• VB.NET

public string CreateFile(string newFilePath, long fileLength);

Async Version
public async Task<string> CreateFile(string newFilePath, long fileLength);
public async Task<string> CreateFile(string newFilePath, long fileLength, CancellationToken cancellationToken);

Public Function CreateFile(ByVal NewFilePath As String, ByVal FileLength As Long) As String

Async Version
Public Function CreateFile(ByVal NewFilePath As String, ByVal FileLength As Long) As Task(Of String)
Public Function CreateFile(ByVal NewFilePath As String, ByVal FileLength As Long, cancellationToken As CancellationToken) As Task(Of 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. The path of the newly-initialized file is returned.

Any parent folders included in NewFilePath must already exist.

If the SendMetadata configuration setting is enabled when this method is called, all items in the Metadata 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.

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 method can be used to upload ranges of data (up to 4MB at once) to the file.
• The ClearRange 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.

CreateFolder Method (AzureFile Component)

Creates a new folder.

Syntax

• C#
• VB.NET

public string CreateFolder(string newFolderPath);

Async Version
public async Task<string> CreateFolder(string newFolderPath);
public async Task<string> CreateFolder(string newFolderPath, CancellationToken cancellationToken);

Public Function CreateFolder(ByVal NewFolderPath As String) As String

Async Version
Public Function CreateFolder(ByVal NewFolderPath As String) As Task(Of String)
Public Function CreateFolder(ByVal NewFolderPath As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

This method creates a new folder at the specified NewFolderPath in the share currently selected by Share. The path of the newly-created folder is returned.

Any parent folders included in NewFolderPath must already exist.

If the SendMetadata configuration setting is enabled when this method is called, all items in the Metadata collection will be sent along with the creation request.

CreateShare Method (AzureFile Component)

Creates a new share.

Syntax

• C#
• VB.NET

public void CreateShare();

Async Version
public async Task CreateShare();
public async Task CreateShare(CancellationToken cancellationToken);

Public Sub CreateShare()

Async Version
Public Sub CreateShare() As Task
Public Sub CreateShare(cancellationToken As CancellationToken) As Task

Remarks

This method creates a new share using the name specified by the Share property.

If the 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 method.

If the SendMetadata configuration setting is enabled when this method is called, all items in the Metadata 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 component 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).

DeleteFile Method (AzureFile Component)

Deletes a file.

Syntax

• C#
• VB.NET

public void DeleteFile(string filePath);

Async Version
public async Task DeleteFile(string filePath);
public async Task DeleteFile(string filePath, CancellationToken cancellationToken);

Public Sub DeleteFile(ByVal FilePath As String)

Async Version
Public Sub DeleteFile(ByVal FilePath As String) As Task
Public Sub DeleteFile(ByVal FilePath As String, cancellationToken As CancellationToken) As Task

Remarks

This method deletes the file at the specified FilePath in the share currently selected by Share.

DeleteFolder Method (AzureFile Component)

Deletes a folder.

Syntax

• C#
• VB.NET

public void DeleteFolder(string folderPath);

Async Version
public async Task DeleteFolder(string folderPath);
public async Task DeleteFolder(string folderPath, CancellationToken cancellationToken);

Public Sub DeleteFolder(ByVal FolderPath As String)

Async Version
Public Sub DeleteFolder(ByVal FolderPath As String) As Task
Public Sub DeleteFolder(ByVal FolderPath As String, cancellationToken As CancellationToken) As Task

Remarks

This method deletes the folder at the specified FolderPath in the share currently selected by Share.

Only empty folders may be deleted; non-empty folders must be emptied first.

DeleteShare Method (AzureFile Component)

Deletes a share.

Syntax

• C#
• VB.NET

public void DeleteShare();

Async Version
public async Task DeleteShare();
public async Task DeleteShare(CancellationToken cancellationToken);

Public Sub DeleteShare()

Async Version
Public Sub DeleteShare() As Task
Public Sub DeleteShare(cancellationToken As CancellationToken) As Task

Remarks

This method deletes the share currently selected by the Share property.

If the currently selected Share has any snapshots associated with it, and the 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.

Note that, according to the Azure File Storage documentation, a share's name cannot be reused until at least 30 seconds after its deletion.

DownloadFile Method (AzureFile Component)

Downloads a file.

Syntax

• C#
• VB.NET

public void DownloadFile(string filePath);

Async Version
public async Task DownloadFile(string filePath);
public async Task DownloadFile(string filePath, CancellationToken cancellationToken);

Public Sub DownloadFile(ByVal FilePath As String)

Async Version
Public Sub DownloadFile(ByVal FilePath As String) As Task
Public Sub DownloadFile(ByVal FilePath As String, cancellationToken As CancellationToken) As Task

Remarks

This method downloads the file at the specified FilePath in the share currently selected by Share.

If a stream has been specified using SetDownloadStream, the file data will be sent through it. If a stream is not specified, and LocalFile is set, the file will be saved to the specified location; otherwise, the file data will be held by ResourceData.

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

Download Notes

In the simplest use-case, downloading a file looks like this: azurefile.LocalFile = "../MyFile.zip"; azurefile.DownloadFile(azurefile.Resources[0].Path);

Resuming Downloads

The component also supports resuming failed downloads by using the StartByte property. If a download is interrupted, set StartByte to the appropriate offset before calling this method to resume the download. string downloadFile = "../MyFile.zip"; azurefile.LocalFile = downloadFile; azurefile.DownloadFile(azurefile.Resources[0].Path); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially downloaded file azurefile.StartByte = new FileInfo(downloadFile).Length; azurefile.DownloadFile(azurefile.Resources[0].Path);

Resuming Encrypted File Downloads

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

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

To resume, DownloadTempFile must be populated, along with StartByte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to LocalFile. azurefile.LocalFile = "../MyFile.zip"; azurefile.EncryptionPassword = "password"; azurefile.DownloadFile(azurefile.Resources[0].Path); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially download temp file azurefile.StartByte = new FileInfo(azurefile.Config("DownloadTempFile")).Length; azurefile.DownloadFile(azurefile.Resources[0].Path);

GetFileInfo Method (AzureFile Component)

Gets a file's information and metadata.

Syntax

• C#
• VB.NET

public void GetFileInfo(string filePath);

Async Version
public async Task GetFileInfo(string filePath);
public async Task GetFileInfo(string filePath, CancellationToken cancellationToken);

Public Sub GetFileInfo(ByVal FilePath As String)

Async Version
Public Sub GetFileInfo(ByVal FilePath As String) As Task
Public Sub GetFileInfo(ByVal FilePath As String, cancellationToken As CancellationToken) As Task

Remarks

This method gets information and metadata for the file at the specified FilePath in the share currently selected by Share.

Calling this method will fire the ResourceList event, will re-populate the Resources collection with a single item, and will re-populate the Metadata collection with any metadata currently associated with the file.

GetFolderInfo Method (AzureFile Component)

Gets a folder's information and metadata.

Syntax

• C#
• VB.NET

public void GetFolderInfo(string folderPath);

Async Version
public async Task GetFolderInfo(string folderPath);
public async Task GetFolderInfo(string folderPath, CancellationToken cancellationToken);

Public Sub GetFolderInfo(ByVal FolderPath As String)

Async Version
Public Sub GetFolderInfo(ByVal FolderPath As String) As Task
Public Sub GetFolderInfo(ByVal FolderPath As String, cancellationToken As CancellationToken) As Task

Remarks

This method gets information and metadata for the folder at the specified FolderPath in the share currently selected by Share.

FolderPath can be empty string to get information about the root folder of the share.

Calling this method will fire the ResourceList event, will re-populate the Resources collection with a single item, and will re-populate the Metadata collection with any metadata currently associated with the folder.

GetLink Method (AzureFile Component)

Creates a link that provides access to a share or file.

Syntax

• C#
• VB.NET

public string GetLink(string filePath, string permissions, string startTime, string expiryTime);

Async Version
public async Task<string> GetLink(string filePath, string permissions, string startTime, string expiryTime);
public async Task<string> GetLink(string filePath, string permissions, string startTime, string expiryTime, CancellationToken cancellationToken);

Public Function GetLink(ByVal FilePath As String, ByVal Permissions As String, ByVal StartTime As String, ByVal ExpiryTime As String) As String

Async Version
Public Function GetLink(ByVal FilePath As String, ByVal Permissions As String, ByVal StartTime As String, ByVal ExpiryTime As String) As Task(Of String)
Public Function GetLink(ByVal FilePath As String, ByVal Permissions As String, ByVal StartTime As String, ByVal ExpiryTime As String, cancellationToken As CancellationToken) As Task(Of 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:

Permissions specifies what permissions the SAS grants, in the form of an abbreviated permissions list. Refer to this section 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 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 collection.

If any of the query parameters listed below are present in the QueryParams 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 article.

GetRanges Method (AzureFile Component)

Gets the list of allocated data ranges in a file.

Syntax

• C#
• VB.NET

public void GetRanges(string filePath);

Async Version
public async Task GetRanges(string filePath);
public async Task GetRanges(string filePath, CancellationToken cancellationToken);

Public Sub GetRanges(ByVal FilePath As String)

Async Version
Public Sub GetRanges(ByVal FilePath As String) As Task
Public Sub GetRanges(ByVal FilePath As String, cancellationToken As CancellationToken) As Task

Remarks

This method gets the list of allocated data ranges in the file at the specified FilePath in the share currently selected by Share and populates the Ranges collection with the results.

The server tracks ranges of file data in 512-byte chunks, aligned to the absolute beginning of the file; thus, the size of every range returned by this method will always be a multiple of 512. Chunks that are not currently allocated (either because no data has been written to them, or because they've been freed with ClearRange) will not be returned by this method.

GetShareInfo Method (AzureFile Component)

Gets a share's information and metadata.

Syntax

• C#
• VB.NET

public void GetShareInfo();

Async Version
public async Task GetShareInfo();
public async Task GetShareInfo(CancellationToken cancellationToken);

Public Sub GetShareInfo()

Async Version
Public Sub GetShareInfo() As Task
Public Sub GetShareInfo(cancellationToken As CancellationToken) As Task

Remarks

This method gets information and metadata for the share currently selected by the Share property.

Calling this method will fire the ShareList event, will re-populate the Shares collection with a single item, and will re-populate the Metadata collection with any metadata currently associated with the share.

Interrupt Method (AzureFile Component)

This method interrupts the current method.

Syntax

• C#
• VB.NET

public void Interrupt();

Async Version
public async Task Interrupt();
public async Task Interrupt(CancellationToken cancellationToken);

Public Sub Interrupt()

Async Version
Public Sub Interrupt() As Task
Public Sub Interrupt(cancellationToken As CancellationToken) As Task

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ListResources Method (AzureFile Component)

Lists resources in a given folder.

Syntax

• C#
• VB.NET

public void ListResources(string folderPath);

Async Version
public async Task ListResources(string folderPath);
public async Task ListResources(string folderPath, CancellationToken cancellationToken);

Public Sub ListResources(ByVal FolderPath As String)

Async Version
Public Sub ListResources(ByVal FolderPath As String) As Task
Public Sub ListResources(ByVal FolderPath As String, cancellationToken As CancellationToken) As Task

Remarks

This method lists the resources in the folder at the specified FolderPath in the share currently selected by Share.

Before calling this method, the Prefix property may be set in order to restrict the results to only the items whose names begin with a given string. The MaxResults configuration setting may also be used to limit the number of results returned.

Calling this method will fire the ResourceList event once for each resource, and will also populate the Resources collection.

If there are still more resources available to list when this method returns, the ResourceMarker property will be populated. Continue to call this method until ResourceMarker is empty to accumulate all pages of results in the Resources collection. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Resources collection every time a page of results is returned.

Note that the server only returns the following resource fields when listing resources (use GetFileInfo or GetFolderInfo to retrieve all fields for a specific resource):

• Name
• Path (populated by the component automatically)
• Share (populated by the component automatically)
• Size
• Type

ListShares Method (AzureFile Component)

Lists shares in the file storage account.

Syntax

• C#
• VB.NET

public void ListShares();

Async Version
public async Task ListShares();
public async Task ListShares(CancellationToken cancellationToken);

Public Sub ListShares()

Async Version
Public Sub ListShares() As Task
Public Sub ListShares(cancellationToken As CancellationToken) As Task

Remarks

This method lists the shares in the file storage account specified by the Account property.

Before calling this method, the Prefix property may be set in order to restrict the results to only the items whose names begin with a given string. The MaxResults configuration setting may also be used to limit the number of results returned.

Calling this method will fire the ShareList event once for each share, and will also populate the Shares collection.

If there are still more shares available to list when this method returns, the ShareMarker property will be populated. Continue to call this method until ShareMarker is empty to accumulate all pages of results in the Shares collection. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Shares collection every time a page of results is returned.

Note that the server does not return the shares' SpaceUsed field when listing shares; use GetShareInfo to retrieve all fields for a specific share. // 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));

PutRange Method (AzureFile Component)

Uploads a range of data to a file.

Syntax

• C#
• VB.NET

public void PutRange(string filePath, long writeOffset);

Async Version
public async Task PutRange(string filePath, long writeOffset);
public async Task PutRange(string filePath, long writeOffset, CancellationToken cancellationToken);

Public Sub PutRange(ByVal FilePath As String, ByVal WriteOffset As Long)

Async Version
Public Sub PutRange(ByVal FilePath As String, ByVal WriteOffset As Long) As Task
Public Sub PutRange(ByVal FilePath As String, ByVal WriteOffset As Long, cancellationToken As CancellationToken) As Task

Remarks

This method uploads a range of data to the file at the specified FilePath in the share currently selected by Share. 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.

RenameFile Method (AzureFile Component)

Renames a file.

Syntax

• C#
• VB.NET

public void RenameFile(string oldFilePath, string newFilePath);

Async Version
public async Task RenameFile(string oldFilePath, string newFilePath);
public async Task RenameFile(string oldFilePath, string newFilePath, CancellationToken cancellationToken);

Public Sub RenameFile(ByVal OldFilePath As String, ByVal NewFilePath As String)

Async Version
Public Sub RenameFile(ByVal OldFilePath As String, ByVal NewFilePath As String) As Task
Public Sub RenameFile(ByVal OldFilePath As String, ByVal NewFilePath As String, cancellationToken As CancellationToken) As Task

Remarks

This method moves and/or renames an existing file on the server at the specified OldFilePath in the share currently selected by Share. The NewFilePath parameter indicates the new location and name of the file.

Any parent folders included in NewFilePath must already exist.

The Overwrite property can optionally be enabled to overwrite the file if it already exists at the location specified by NewFilePath.

RenameFolder Method (AzureFile Component)

Renames a directory.

Syntax

• C#
• VB.NET

public void RenameFolder(string oldDirPath, string newDirPath);

Async Version
public async Task RenameFolder(string oldDirPath, string newDirPath);
public async Task RenameFolder(string oldDirPath, string newDirPath, CancellationToken cancellationToken);

Public Sub RenameFolder(ByVal OldDirPath As String, ByVal NewDirPath As String)

Async Version
Public Sub RenameFolder(ByVal OldDirPath As String, ByVal NewDirPath As String) As Task
Public Sub RenameFolder(ByVal OldDirPath As String, ByVal NewDirPath As String, cancellationToken As CancellationToken) As Task

Remarks

This method moves and/or renames an existing folder on the server at the specified OldDirPath in the share currently selected by Share. The NewDirPath parameter indicates the new location and name of the folder.

Any parent folders included in NewDirPath must already exist.

Reset Method (AzureFile Component)

Resets the component to its initial state.

Syntax

• C#
• VB.NET

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

This method resets the component to its initial state.

ResizeFile Method (AzureFile Component)

Resizes a file.

Syntax

• C#
• VB.NET

public void ResizeFile(string filePath, long newSize);

Async Version
public async Task ResizeFile(string filePath, long newSize);
public async Task ResizeFile(string filePath, long newSize, CancellationToken cancellationToken);

Public Sub ResizeFile(ByVal FilePath As String, ByVal NewSize As Long)

Async Version
Public Sub ResizeFile(ByVal FilePath As String, ByVal NewSize As Long) As Task
Public Sub ResizeFile(ByVal FilePath As String, ByVal NewSize As Long, cancellationToken As CancellationToken) As Task

Remarks

This method resizes the file at the specified FilePath in the share currently selected by Share. NewSize, which is specified in bytes, cannot be negative.

SetDownloadStream Method (AzureFile Component)

Sets the stream to which downloaded data will be written.

Syntax

• C#
• VB.NET

public void SetDownloadStream(System.IO.Stream downloadStream);

Async Version
public async Task SetDownloadStream(System.IO.Stream downloadStream);
public async Task SetDownloadStream(System.IO.Stream downloadStream, CancellationToken cancellationToken);

Public Sub SetDownloadStream(ByVal DownloadStream As System.IO.Stream)

Async Version
Public Sub SetDownloadStream(ByVal DownloadStream As System.IO.Stream) As Task
Public Sub SetDownloadStream(ByVal DownloadStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

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 to be cleared. Similarly, setting LocalFile to a non-empty value will discard any stream set using this method.

SetShareQuota Method (AzureFile Component)

Sets a share's space quota.

Syntax

• C#
• VB.NET

public void SetShareQuota(int quota);

Async Version
public async Task SetShareQuota(int quota);
public async Task SetShareQuota(int quota, CancellationToken cancellationToken);

Public Sub SetShareQuota(ByVal Quota As Integer)

Async Version
Public Sub SetShareQuota(ByVal Quota As Integer) As Task
Public Sub SetShareQuota(ByVal Quota As Integer, cancellationToken As CancellationToken) As Task

Remarks

This method sets the size, in GB, of the space quota imposed on the share currently selected by the Share 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.

SetUploadStream Method (AzureFile Component)

Sets the stream from which data is read when uploading.

Syntax

• C#
• VB.NET

public void SetUploadStream(System.IO.Stream uploadStream);

Async Version
public async Task SetUploadStream(System.IO.Stream uploadStream);
public async Task SetUploadStream(System.IO.Stream uploadStream, CancellationToken cancellationToken);

Public Sub SetUploadStream(ByVal UploadStream As System.IO.Stream)

Async Version
Public Sub SetUploadStream(ByVal UploadStream As System.IO.Stream) As Task
Public Sub SetUploadStream(ByVal UploadStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

If an upload stream is set before data is uploaded, the content of the stream will be read by the component 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 to be cleared. Similarly, setting LocalFile to a non-empty value will discard any stream set using this method.

UpdateMetadata Method (AzureFile Component)

Sets the metadata for a file, folder, or share.

Syntax

• C#
• VB.NET

public void UpdateMetadata(string path, int resourceType);

Async Version
public async Task UpdateMetadata(string path, int resourceType);
public async Task UpdateMetadata(string path, int resourceType, CancellationToken cancellationToken);

Public Sub UpdateMetadata(ByVal Path As String, ByVal ResourceType As Integer)

Async Version
Public Sub UpdateMetadata(ByVal Path As String, ByVal ResourceType As Integer) As Task
Public Sub UpdateMetadata(ByVal Path As String, ByVal ResourceType As Integer, cancellationToken As CancellationToken) As Task

Remarks

This method sets the metadata for a file, folder, or share to the items currently held by the Metadata collection. The ResourceType parameter indicates the kind of resource the component 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.
• 1: Set the metadata for the folder at the specified Path in the share currently selected by Share.
• 2: Set the metadata for the share currently selected by Share (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.

UploadFile Method (AzureFile Component)

Uploads a new file resource.

Syntax

• C#
• VB.NET

public string UploadFile(string newFilePath);

Async Version
public async Task<string> UploadFile(string newFilePath);
public async Task<string> UploadFile(string newFilePath, CancellationToken cancellationToken);

Public Function UploadFile(ByVal NewFilePath As String) As String

Async Version
Public Function UploadFile(ByVal NewFilePath As String) As Task(Of String)
Public Function UploadFile(ByVal NewFilePath As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

This method uploads a new file resource at the specified NewFilePath in the share currently selected by Share. The path of the newly-created file is returned.

Any parent folders included in NewFilePath must already exist.

If the SendMetadata configuration setting is enabled when this method is called, all items in the Metadata collection will be sent along with the creation request.

If SetUploadStream has been used to set an upload stream, it will take priority as the file data source. If LocalFile is set the file will be uploaded from the specified path. If LocalFile is not set the data in ResourceData will be used.

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

Upload Notes

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

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

If the upload is interrupted for any reason, resuming it is easy. First, verify that StartByte is populated (if the same instance of the component is used, they should already be populated, and no special action should be needed). If uploading from a stream, be sure to reset its position to where it was the first time the upload was started (typically the beginning). Then call UploadFile again to resume the upload at the specified StartByte offset. azurefile.LocalFile = "../MyFile.zip"; azurefile.UploadFile("MyFile.zip"); //The transfer is interrupted and UploadFile() above fails. Later, resume the download. //Using the same instance StartByte is already populated from the previous upload attempt. azurefile.UploadFile("MyFile.zip"); MemoryStream uploadStream = new MemoryStream(File.ReadAllBytes("../MyFile.zip")); azurefile.SetUploadStream(uploadStream); azurefile.UploadFile("MyFile.zip"); //The transfer is interrupted and UploadFile() above fails. Later, resume the download. //Using the same instance StartByte is already populated from the previous upload attempt. //You MUST reset the stream's position to where it was when you first started the upload! uploadStream.Position = 0; azurefile.UploadFile("MyFile.zip");

EndTransfer Event (AzureFile Component)

This event fires when a document finishes transferring.

Syntax

• C#
• VB.NET

public event OnEndTransferHandler OnEndTransfer;

public delegate void OnEndTransferHandler(object sender, AzureFileEndTransferEventArgs e);

public class AzureFileEndTransferEventArgs : EventArgs {
  public int Direction { get; }
}

Public Event OnEndTransfer As OnEndTransferHandler

Public Delegate Sub OnEndTransferHandler(sender As Object, e As AzureFileEndTransferEventArgs)

Public Class AzureFileEndTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
End Class

Remarks

The EndTransfer event is fired 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.

Error Event (AzureFile Component)

Fired when information is available about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, AzureFileErrorEventArgs e);

public class AzureFileErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As AzureFileErrorEventArgs)

Public Class AzureFileErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

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 section.

FragmentComplete Event (AzureFile Component)

Fires after each fragment of a resumable upload is completed.

Syntax

• C#
• VB.NET

public event OnFragmentCompleteHandler OnFragmentComplete;

public delegate void OnFragmentCompleteHandler(object sender, AzureFileFragmentCompleteEventArgs e);

public class AzureFileFragmentCompleteEventArgs : EventArgs {
  public int FragmentNumber { get; }
  public int FragmentCount { get; }
  public bool Interrupt { get; set; }
}

Public Event OnFragmentComplete As OnFragmentCompleteHandler

Public Delegate Sub OnFragmentCompleteHandler(sender As Object, e As AzureFileFragmentCompleteEventArgs)

Public Class AzureFileFragmentCompleteEventArgs Inherits EventArgs
  Public ReadOnly Property FragmentNumber As Integer
  Public ReadOnly Property FragmentCount As Integer
  Public Property Interrupt As Boolean
End Class

Remarks

When UploadFile 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.

Header Event (AzureFile Component)

Fired every time a header line comes in.

Syntax

• C#
• VB.NET

public event OnHeaderHandler OnHeader;

public delegate void OnHeaderHandler(object sender, AzureFileHeaderEventArgs e);

public class AzureFileHeaderEventArgs : EventArgs {
  public string Field { get; }
  public string Value { get; }
}

Public Event OnHeader As OnHeaderHandler

Public Delegate Sub OnHeaderHandler(sender As Object, e As AzureFileHeaderEventArgs)

Public Class AzureFileHeaderEventArgs Inherits EventArgs
  Public ReadOnly Property Field As String
  Public ReadOnly Property Value As String
End Class

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).

Log Event (AzureFile Component)

Fired once for each log message.

Syntax

• C#
• VB.NET

public event OnLogHandler OnLog;

public delegate void OnLogHandler(object sender, AzureFileLogEventArgs e);

public class AzureFileLogEventArgs : EventArgs {
  public int LogLevel { get; }
  public string Message { get; }
  public string LogType { get; }
}

Public Event OnLog As OnLogHandler

Public Delegate Sub OnLogHandler(sender As Object, e As AzureFileLogEventArgs)

Public Class AzureFileLogEventArgs Inherits EventArgs
  Public ReadOnly Property LogLevel As Integer
  Public ReadOnly Property Message As String
  Public ReadOnly Property LogType As String
End Class

Remarks

This event is fired once for each log message generated by the component. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

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"

Progress Event (AzureFile Component)

Fires during an upload or download to indicate transfer progress.

Syntax

• C#
• VB.NET

public event OnProgressHandler OnProgress;

public delegate void OnProgressHandler(object sender, AzureFileProgressEventArgs e);

public class AzureFileProgressEventArgs : EventArgs {
  public int Direction { get; }
  public long BytesTransferred { get; }
  public long TotalBytes { get; }
  public int PercentDone { get; }
}

Public Event OnProgress As OnProgressHandler

Public Delegate Sub OnProgressHandler(sender As Object, e As AzureFileProgressEventArgs)

Public Class AzureFileProgressEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property BytesTransferred As Long
  Public ReadOnly Property TotalBytes As Long
  Public ReadOnly Property PercentDone As Integer
End Class

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 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 component 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 configuration setting, in which case the component 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.

ResourceList Event (AzureFile Component)

Fires once for each resource returned when listing resources.

Syntax

• C#
• VB.NET

public event OnResourceListHandler OnResourceList;

public delegate void OnResourceListHandler(object sender, AzureFileResourceListEventArgs e);

public class AzureFileResourceListEventArgs : EventArgs {
  public string Name { get; }
  public string Path { get; }
  public string Share { get; }
  public int ResourceType { get; }
  public string ModifiedTime { get; }
  public long Size { get; }
  public string ETag { get; }
}

Public Event OnResourceList As OnResourceListHandler

Public Delegate Sub OnResourceListHandler(sender As Object, e As AzureFileResourceListEventArgs)

Public Class AzureFileResourceListEventArgs Inherits EventArgs
  Public ReadOnly Property Name As String
  Public ReadOnly Property Path As String
  Public ReadOnly Property Share As String
  Public ReadOnly Property ResourceType As Integer
  Public ReadOnly Property ModifiedTime As String
  Public ReadOnly Property Size As Long
  Public ReadOnly Property ETag As String
End Class

Remarks

This event fires once for each resource returned when ListResources, GetFileInfo, or GetFolderInfo 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:

ModifiedTime is the last modified time of the resource, formatted according to RFC 1123. (Note: this parameter is not populated by calls to ListResources.)

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.)

ShareList Event (AzureFile Component)

Fires once for each share returned when listing shares.

Syntax

• C#
• VB.NET

public event OnShareListHandler OnShareList;

public delegate void OnShareListHandler(object sender, AzureFileShareListEventArgs e);

public class AzureFileShareListEventArgs : EventArgs {
  public string Name { get; }
  public string ModifiedTime { get; }
  public string ETag { get; }
  public int Quota { get; }
}

Public Event OnShareList As OnShareListHandler

Public Delegate Sub OnShareListHandler(sender As Object, e As AzureFileShareListEventArgs)

Public Class AzureFileShareListEventArgs Inherits EventArgs
  Public ReadOnly Property Name As String
  Public ReadOnly Property ModifiedTime As String
  Public ReadOnly Property ETag As String
  Public ReadOnly Property Quota As Integer
End Class

Remarks

This event fires once for each share returned when ListShares or GetShareInfo 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.

SSLServerAuthentication Event (AzureFile Component)

Fired after the server presents its certificate to the client.

Syntax

• C#
• VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, AzureFileSSLServerAuthenticationEventArgs e);

public class AzureFileSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As AzureFileSSLServerAuthenticationEventArgs)

Public Class AzureFileSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (AzureFile Component)

Fired when secure connection progress messages are available.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, AzureFileSSLStatusEventArgs e);

public class AzureFileSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As AzureFileSSLStatusEventArgs)

Public Class AzureFileSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (AzureFile Component)

This event fires when a document starts transferring (after the headers).

Syntax

• C#
• VB.NET

public event OnStartTransferHandler OnStartTransfer;

public delegate void OnStartTransferHandler(object sender, AzureFileStartTransferEventArgs e);

public class AzureFileStartTransferEventArgs : EventArgs {
  public int Direction { get; }
}

Public Event OnStartTransfer As OnStartTransferHandler

Public Delegate Sub OnStartTransferHandler(sender As Object, e As AzureFileStartTransferEventArgs)

Public Class AzureFileStartTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
End Class

Remarks

The StartTransfer event is fired 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.

Transfer Event (AzureFile Component)

Fired while a document transfers (delivers document).

Syntax

• C#
• VB.NET

public event OnTransferHandler OnTransfer;

public delegate void OnTransferHandler(object sender, AzureFileTransferEventArgs e);

public class AzureFileTransferEventArgs : EventArgs {
  public int Direction { get; }
  public long BytesTransferred { get; }
  public int PercentDone { get; }
  public string Text { get; }
  public byte[] TextB { get; }
}

Public Event OnTransfer As OnTransferHandler

Public Delegate Sub OnTransferHandler(sender As Object, e As AzureFileTransferEventArgs)

Public Class AzureFileTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property BytesTransferred As Long
  Public ReadOnly Property PercentDone As Integer
  Public ReadOnly Property Text As String
  Public ReadOnly Property TextB As Byte()
End Class

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.

Fields

Constructors

• C#
• VB.NET

public AzureFileResource();

Public AzureFileResource()

AzureFileShare Type

An Azure File service share.

Remarks

This type represents an Azure File service share.

Fields

Constructors

• C#
• VB.NET

public AzureFileShare();

Public AzureFileShare()

AzureMetadata Type

An Azure metadata item.

Remarks

This type represents an Azure metadata item.

Fields

Constructors

• C#
• VB.NET

public AzureMetadata();

Public AzureMetadata()

• C#
• VB.NET

public AzureMetadata(string name, string value);

Public AzureMetadata(ByVal Name As String, ByVal Value As String)

AzureRange Type

An Azure byte range.

Remarks

This type represents an Azure byte range.

Fields

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.

Fields

Constructors

• C#
• VB.NET

public Certificate();

Public Certificate()

• C#
• VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

• C#
• VB.NET

public Certificate(byte[] encoded);

Public Certificate(ByVal Encoded As Byte())

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

• C#
• VB.NET

public Firewall();

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 type. This type contains a Field, and its corresponding Value.

Fields

Constructors

• C#
• VB.NET

public Header();

Public Header()

• C#
• VB.NET

public Header(string field, string value);

Public Header(ByVal Field As String, ByVal Value As String)

OAuthSettings Type

The settings to use to authenticate with the service provider.

Remarks

Used to set give the component the necessary information needed to complete OAuth authentication.

Fields

Constructors

• C#
• VB.NET

public OAuthSettings();

Public OAuthSettings()

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

Fields

Constructors

• C#
• VB.NET

public Proxy();

Public Proxy()

• C#
• VB.NET

public Proxy(string server, int port);

Public Proxy(ByVal Server As String, ByVal Port As Integer)

• C#
• VB.NET

public Proxy(string server, int port, string user, string password);

Public Proxy(ByVal Server As String, ByVal Port As Integer, ByVal User As String, ByVal Password As String)

QueryParam Type

A query parameter to send in the request.

Remarks

This type represents a query parameter to send in the request.

Fields

Constructors

• C#
• VB.NET

public QueryParam();

Public QueryParam()

• C#
• VB.NET

public QueryParam(string name, string value);

Public QueryParam(ByVal Name As String, ByVal Value As String)

Config Settings (AzureFile Component)

AzureFile Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

HTTP Config Settings