AzureFile Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

CloudStorage_AzureFile

Procedural Interface

 cloudstorage_azurefile_open();
 cloudstorage_azurefile_close($res);
 cloudstorage_azurefile_register_callback($res, $id, $function);
 cloudstorage_azurefile_get_last_error($res);
 cloudstorage_azurefile_get_last_error_code($res);
 cloudstorage_azurefile_set($res, $id, $index, $value);
 cloudstorage_azurefile_get($res, $id, $index);
 cloudstorage_azurefile_do_abortcopy($res, $destfilepath, $copyid);
 cloudstorage_azurefile_do_addmetadata($res, $name, $value);
 cloudstorage_azurefile_do_addqueryparam($res, $name, $value);
 cloudstorage_azurefile_do_authorize($res);
 cloudstorage_azurefile_do_clearrange($res, $filepath, $first, $last);
 cloudstorage_azurefile_do_config($res, $configurationstring);
 cloudstorage_azurefile_do_copyfile($res, $fromfilepath, $tofilepath, $toshare);
 cloudstorage_azurefile_do_createfile($res, $newfilepath, $filelength);
 cloudstorage_azurefile_do_createfolder($res, $newfolderpath);
 cloudstorage_azurefile_do_createshare($res);
 cloudstorage_azurefile_do_deletefile($res, $filepath);
 cloudstorage_azurefile_do_deletefolder($res, $folderpath);
 cloudstorage_azurefile_do_deleteshare($res);
 cloudstorage_azurefile_do_downloadfile($res, $filepath);
 cloudstorage_azurefile_do_getfileinfo($res, $filepath);
 cloudstorage_azurefile_do_getfolderinfo($res, $folderpath);
 cloudstorage_azurefile_do_getlink($res, $filepath, $permissions, $starttime, $expirytime);
 cloudstorage_azurefile_do_getranges($res, $filepath);
 cloudstorage_azurefile_do_getshareinfo($res);
 cloudstorage_azurefile_do_interrupt($res);
 cloudstorage_azurefile_do_listresources($res, $folderpath);
 cloudstorage_azurefile_do_listshares($res);
 cloudstorage_azurefile_do_putrange($res, $filepath, $writeoffset);
 cloudstorage_azurefile_do_renamefile($res, $oldfilepath, $newfilepath);
 cloudstorage_azurefile_do_renamefolder($res, $olddirpath, $newdirpath);
 cloudstorage_azurefile_do_reset($res);
 cloudstorage_azurefile_do_resizefile($res, $filepath, $newsize);
 cloudstorage_azurefile_do_setsharequota($res, $quota);
 cloudstorage_azurefile_do_updatemetadata($res, $path, $resourcetype);
 cloudstorage_azurefile_do_uploadfile($res, $newfilepath);

Remarks

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

Authentication

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

Addressing Resources

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

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

Listing Directory Contents

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

Downloading Files

The DownloadFile method downloads files.

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

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

Download Notes

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

Resuming Downloads

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

Resuming Encrypted File Downloads

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

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

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

Uploading Files

The UploadFile method uploads new files.

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

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

Upload Notes

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

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

If the upload is interrupted for any reason, resuming it is easy. First, verify that StartByte is populated (if the same instance of the class is used, they should already be populated, and no special action should be needed). Then call UploadFile again to resume the upload at the specified StartByte offset. azurefile.LocalFile = "../MyFile.zip"; azurefile.UploadFile("MyFile.zip"); //The transfer is interrupted and UploadFile() above fails. Later, resume the download. //Using the same instance StartByte is already populated from the previous upload attempt. azurefile.UploadFile("MyFile.zip");

Additional Functionality

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

• 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 class with short descriptions. Click on the links for further details.

Method List

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

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.

Config Settings

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

AccessKey Property (CloudStorage_AzureFile Class)

The Azure access key to use for authentication.

Object Oriented Interface

public function getAccessKey();


public function setAccessKey($value);

Procedural Interface

cloudstorage_azurefile_get($res, 1 );


cloudstorage_azurefile_set($res, 1, $value );

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.

Data Type

String

Account Property (CloudStorage_AzureFile Class)

The Azure storage account name.

Object Oriented Interface

public function getAccount();


public function setAccount($value);

Procedural Interface

cloudstorage_azurefile_get($res, 2 );


cloudstorage_azurefile_set($res, 2, $value );

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.

Data Type

String

Authorization Property (CloudStorage_AzureFile Class)

OAuth 2.0 Authorization Token.

Object Oriented Interface

public function getAuthorization();


public function setAuthorization($value);

Procedural Interface

cloudstorage_azurefile_get($res, 3 );


cloudstorage_azurefile_set($res, 3, $value );

Default Value

''

Remarks

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

Bearer ACCESS_TOKEN

TBD.

Data Type

String

EncryptionAlgorithm Property (CloudStorage_AzureFile Class)

The encryption algorithm.

Object Oriented Interface

public function getEncryptionAlgorithm();


public function setEncryptionAlgorithm($value);

Procedural Interface

cloudstorage_azurefile_get($res, 4 );


cloudstorage_azurefile_set($res, 4, $value );

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:

Data Type

Integer

EncryptionPassword Property (CloudStorage_AzureFile Class)

The encryption password.

Object Oriented Interface

public function getEncryptionPassword();


public function setEncryptionPassword($value);

Procedural Interface

cloudstorage_azurefile_get($res, 5 );


cloudstorage_azurefile_set($res, 5, $value );

Default Value

''

Remarks

If this property is populated when UploadFile or DownloadFile 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 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.

Data Type

String

FirewallAutoDetect Property (CloudStorage_AzureFile Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();


public function setFirewallAutoDetect($value);

Procedural Interface

cloudstorage_azurefile_get($res, 6 );


cloudstorage_azurefile_set($res, 6, $value );

Default Value

false

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (CloudStorage_AzureFile Class)

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

cloudstorage_azurefile_get($res, 7 );


cloudstorage_azurefile_set($res, 7, $value );

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (CloudStorage_AzureFile Class)

This property contains the name or IP address of the firewall (optional).

Object Oriented Interface

public function getFirewallHost();


public function setFirewallHost($value);

Procedural Interface

cloudstorage_azurefile_get($res, 8 );


cloudstorage_azurefile_set($res, 8, $value );

Default Value

''

Remarks

This property contains the name or IP address of the firewall (optional). If a FirewallHost 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 fails with an error.

Data Type

String

FirewallPassword Property (CloudStorage_AzureFile Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();


public function setFirewallPassword($value);

Procedural Interface

cloudstorage_azurefile_get($res, 9 );


cloudstorage_azurefile_set($res, 9, $value );

Default Value

''

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (CloudStorage_AzureFile Class)

This property contains the Transmission Control Protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();


public function setFirewallPort($value);

Procedural Interface

cloudstorage_azurefile_get($res, 10 );


cloudstorage_azurefile_set($res, 10, $value );

Default Value

0

Remarks

This property contains the Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (CloudStorage_AzureFile Class)

This property contains a username if authentication is to be used when connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();


public function setFirewallUser($value);

Procedural Interface

cloudstorage_azurefile_get($res, 11 );


cloudstorage_azurefile_set($res, 11, $value );

Default Value

''

Remarks

This property contains a username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

Idle Property (CloudStorage_AzureFile Class)

This property specifies the current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

cloudstorage_azurefile_get($res, 12 );

Default Value

true

Remarks

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

Data Type

Boolean

LocalFile Property (CloudStorage_AzureFile Class)

The location of the local file.

Object Oriented Interface

public function getLocalFile();


public function setLocalFile($value);

Procedural Interface

cloudstorage_azurefile_get($res, 13 );


cloudstorage_azurefile_set($res, 13, $value );

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.

Data Type

String

LocalHost Property (CloudStorage_AzureFile Class)

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

Object Oriented Interface

public function getLocalHost();


public function setLocalHost($value);

Procedural Interface

cloudstorage_azurefile_get($res, 14 );


cloudstorage_azurefile_set($res, 14, $value );

Default Value

''

Remarks

The LocalHost 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 classs) 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.

Data Type

String

MetadataCount Property (CloudStorage_AzureFile Class)

The number of records in the Metadata arrays.

Object Oriented Interface

public function getMetadataCount();


public function setMetadataCount($value);

Procedural Interface

cloudstorage_azurefile_get($res, 15 );


cloudstorage_azurefile_set($res, 15, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• MetadataName
• MetadataValue

The array indices start at 0 and end at MetadataCount - 1.

This property is not available at design time.

Data Type

Integer

MetadataName Property (CloudStorage_AzureFile Class)

The name of the metadata item.

Object Oriented Interface

public function getMetadataName($metadataindex);


public function setMetadataName($metadataindex, $value);

Procedural Interface

cloudstorage_azurefile_get($res, 16 , $metadataindex);


cloudstorage_azurefile_set($res, 16, $value , $metadataindex);

Default Value

''

Remarks

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.

The $metadataindex parameter specifies the index of the item in the array. The size of the array is controlled by the MetadataCount property.

This property is not available at design time.

Data Type

String

MetadataValue Property (CloudStorage_AzureFile Class)

The value of the metadata item.

Object Oriented Interface

public function getMetadataValue($metadataindex);


public function setMetadataValue($metadataindex, $value);

Procedural Interface

cloudstorage_azurefile_get($res, 17 , $metadataindex);


cloudstorage_azurefile_set($res, 17, $value , $metadataindex);

Default Value

''

Remarks

The value of the metadata item.

This property specifies the value of the metadata item.

The $metadataindex parameter specifies the index of the item in the array. The size of the array is controlled by the MetadataCount property.

This property is not available at design time.

Data Type

String

OAuthAccessToken Property (CloudStorage_AzureFile Class)

The access token returned by the authorization server.

Object Oriented Interface

public function getOAuthAccessToken();


public function setOAuthAccessToken($value);

Procedural Interface

cloudstorage_azurefile_get($res, 18 );


cloudstorage_azurefile_set($res, 18, $value );

Default Value

''

Remarks

The access token returned by the authorization server. This is set when the class makes a request to the token server.

This property is not available at design time.

Data Type

String

OAuthAuthorizationCode Property (CloudStorage_AzureFile Class)

The authorization code that is exchanged for an access token.

Object Oriented Interface

public function getOAuthAuthorizationCode();


public function setOAuthAuthorizationCode($value);

Procedural Interface

cloudstorage_azurefile_get($res, 19 );


cloudstorage_azurefile_set($res, 19, $value );

Default Value

''

Remarks

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.

This property is not available at design time.

Data Type

String

OAuthAuthorizationScope Property (CloudStorage_AzureFile Class)

The scope request or response parameter used during authorization.

Object Oriented Interface

public function getOAuthAuthorizationScope();


public function setOAuthAuthorizationScope($value);

Procedural Interface

cloudstorage_azurefile_get($res, 20 );


cloudstorage_azurefile_set($res, 20, $value );

Default Value

''

Remarks

The scope request or response parameter used during authorization.

This property is not available at design time.

Data Type

String

OAuthClientId Property (CloudStorage_AzureFile Class)

The id of the client assigned when registering the application.

Object Oriented Interface

public function getOAuthClientId();


public function setOAuthClientId($value);

Procedural Interface

cloudstorage_azurefile_get($res, 21 );


cloudstorage_azurefile_set($res, 21, $value );

Default Value

''

Remarks

The id of the client assigned when registering the application.

This property is not available at design time.

Data Type

String

OAuthClientProfile Property (CloudStorage_AzureFile Class)

The type of client that is requesting authorization.

Object Oriented Interface

public function getOAuthClientProfile();


public function setOAuthClientProfile($value);

Procedural Interface

cloudstorage_azurefile_get($res, 22 );


cloudstorage_azurefile_set($res, 22, $value );

Default Value

0

Remarks

The type of client that is requesting authorization. See the introduction section for more information. Possible values are:

This property is not available at design time.

Data Type

Integer

OAuthClientSecret Property (CloudStorage_AzureFile Class)

The secret value for the client assigned when registering the application.

Object Oriented Interface

public function getOAuthClientSecret();


public function setOAuthClientSecret($value);

Procedural Interface

cloudstorage_azurefile_get($res, 23 );


cloudstorage_azurefile_set($res, 23, $value );

Default Value

''

Remarks

The secret value for the client assigned when registering the application.

This property is not available at design time.

Data Type

String

OAuthGrantType Property (CloudStorage_AzureFile Class)

The OAuth grant type used to acquire an OAuth access token.

Object Oriented Interface

public function getOAuthGrantType();


public function setOAuthGrantType($value);

Procedural Interface

cloudstorage_azurefile_get($res, 24 );


cloudstorage_azurefile_set($res, 24, $value );

Default Value

0

Remarks

The OAuth grant type used to acquire an OAuth access token. See the introduction section for more information. Possible values are:

This property is not available at design time.

Data Type

Integer

OAuthRefreshToken Property (CloudStorage_AzureFile Class)

Specifies the refresh token received from or sent to the authorization server.

Object Oriented Interface

public function getOAuthRefreshToken();


public function setOAuthRefreshToken($value);

Procedural Interface

cloudstorage_azurefile_get($res, 25 );


cloudstorage_azurefile_set($res, 25, $value );

Default Value

''

Remarks

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.

This property is not available at design time.

Data Type

String

OAuthRequestRefreshToken Property (CloudStorage_AzureFile Class)

Specifies whether the class will request a refresh token during authorization.

Object Oriented Interface

public function getOAuthRequestRefreshToken();


public function setOAuthRequestRefreshToken($value);

Procedural Interface

cloudstorage_azurefile_get($res, 26 );


cloudstorage_azurefile_set($res, 26, $value );

Default Value

true

Remarks

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.

This property is not available at design time.

Data Type

Boolean

OAuthReturnURL Property (CloudStorage_AzureFile Class)

The URL where the user (browser) returns after authenticating.

Object Oriented Interface

public function getOAuthReturnURL();


public function setOAuthReturnURL($value);

Procedural Interface

cloudstorage_azurefile_get($res, 27 );


cloudstorage_azurefile_set($res, 27, $value );

Default Value

''

Remarks

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.

This property is not available at design time.

Data Type

String

OAuthServerAuthURL Property (CloudStorage_AzureFile Class)

The URL of the authorization server.

Object Oriented Interface

public function getOAuthServerAuthURL();


public function setOAuthServerAuthURL($value);

Procedural Interface

cloudstorage_azurefile_get($res, 28 );


cloudstorage_azurefile_set($res, 28, $value );

Default Value

''

Remarks

The URL of the authorization server.

This property is not available at design time.

Data Type

String

OAuthServerTokenURL Property (CloudStorage_AzureFile Class)

The URL of the token server used to obtain the access token.

Object Oriented Interface

public function getOAuthServerTokenURL();


public function setOAuthServerTokenURL($value);

Procedural Interface

cloudstorage_azurefile_get($res, 29 );


cloudstorage_azurefile_set($res, 29, $value );

Default Value

''

Remarks

The URL of the token server used to obtain the access token.

This property is not available at design time.

Data Type

String

OAuthWebAuthURL Property (CloudStorage_AzureFile Class)

The URL to which the user should be re-directed for authorization.

Object Oriented Interface

public function getOAuthWebAuthURL();

Procedural Interface

cloudstorage_azurefile_get($res, 30 );

Default Value

''

Remarks

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.

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

Data Type

String

OtherHeaders Property (CloudStorage_AzureFile Class)

This property includes other headers as determined by the user (optional).

Object Oriented Interface

public function getOtherHeaders();


public function setOtherHeaders($value);

Procedural Interface

cloudstorage_azurefile_get($res, 31 );


cloudstorage_azurefile_set($res, 31, $value );

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

This property is not available at design time.

Data Type

String

Overwrite Property (CloudStorage_AzureFile Class)

Determines if files are overwritten.

Object Oriented Interface

public function getOverwrite();


public function setOverwrite($value);

Procedural Interface

cloudstorage_azurefile_get($res, 32 );


cloudstorage_azurefile_set($res, 32, $value );

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.

Data Type

Boolean

ParsedHeaderCount Property (CloudStorage_AzureFile Class)

The number of records in the ParsedHeader arrays.

Object Oriented Interface

public function getParsedHeaderCount();

Procedural Interface

cloudstorage_azurefile_get($res, 33 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

The array indices start at 0 and end at ParsedHeaderCount - 1.

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

Data Type

Integer

ParsedHeaderField Property (CloudStorage_AzureFile Class)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Object Oriented Interface

public function getParsedHeaderField($parsedheaderindex);

Procedural Interface

cloudstorage_azurefile_get($res, 34 , $parsedheaderindex);

Default Value

''

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The $parsedheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

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

Data Type

String

ParsedHeaderValue Property (CloudStorage_AzureFile Class)

This property contains the header contents.

Object Oriented Interface

public function getParsedHeaderValue($parsedheaderindex);

Procedural Interface

cloudstorage_azurefile_get($res, 35 , $parsedheaderindex);

Default Value

''

Remarks

This property contains the Header contents.

The $parsedheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

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

Data Type

String

Prefix Property (CloudStorage_AzureFile Class)

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

Object Oriented Interface

public function getPrefix();


public function setPrefix($value);

Procedural Interface

cloudstorage_azurefile_get($res, 36 );


cloudstorage_azurefile_set($res, 36, $value );

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.

Data Type

String

ProxyAuthScheme Property (CloudStorage_AzureFile Class)

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();


public function setProxyAuthScheme($value);

Procedural Interface

cloudstorage_azurefile_get($res, 37 );


cloudstorage_azurefile_set($res, 37, $value );

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme 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 ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (CloudStorage_AzureFile Class)

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Object Oriented Interface

public function getProxyAutoDetect();


public function setProxyAutoDetect($value);

Procedural Interface

cloudstorage_azurefile_get($res, 38 );


cloudstorage_azurefile_set($res, 38, $value );

Default Value

false

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (CloudStorage_AzureFile Class)

This property contains a password if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

cloudstorage_azurefile_get($res, 39 );


cloudstorage_azurefile_set($res, 39, $value );

Default Value

''

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (CloudStorage_AzureFile Class)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

cloudstorage_azurefile_get($res, 40 );


cloudstorage_azurefile_set($res, 40, $value );

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (CloudStorage_AzureFile Class)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Object Oriented Interface

public function getProxyServer();


public function setProxyServer($value);

Procedural Interface

cloudstorage_azurefile_get($res, 41 );


cloudstorage_azurefile_set($res, 41, $value );

Default Value

''

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (CloudStorage_AzureFile Class)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Object Oriented Interface

public function getProxySSL();


public function setProxySSL($value);

Procedural Interface

cloudstorage_azurefile_get($res, 42 );


cloudstorage_azurefile_set($res, 42, $value );

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (CloudStorage_AzureFile Class)

This property contains a username if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();


public function setProxyUser($value);

Procedural Interface

cloudstorage_azurefile_get($res, 43 );


cloudstorage_azurefile_set($res, 43, $value );

Default Value

''

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

QueryParamCount Property (CloudStorage_AzureFile Class)

The number of records in the QueryParam arrays.

Object Oriented Interface

public function getQueryParamCount();


public function setQueryParamCount($value);

Procedural Interface

cloudstorage_azurefile_get($res, 44 );


cloudstorage_azurefile_set($res, 44, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• QueryParamName
• QueryParamValue

The array indices start at 0 and end at QueryParamCount - 1.

This property is not available at design time.

Data Type

Integer

QueryParamName Property (CloudStorage_AzureFile Class)

The name of the query parameter.

Object Oriented Interface

public function getQueryParamName($queryparamindex);


public function setQueryParamName($queryparamindex, $value);

Procedural Interface

cloudstorage_azurefile_get($res, 45 , $queryparamindex);


cloudstorage_azurefile_set($res, 45, $value , $queryparamindex);

Default Value

''

Remarks

The name of the query parameter.

This property specifies the name of the query parameter.

The $queryparamindex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.

This property is not available at design time.

Data Type

String

QueryParamValue Property (CloudStorage_AzureFile Class)

The value of the query parameter.

Object Oriented Interface

public function getQueryParamValue($queryparamindex);


public function setQueryParamValue($queryparamindex, $value);

Procedural Interface

cloudstorage_azurefile_get($res, 46 , $queryparamindex);


cloudstorage_azurefile_set($res, 46, $value , $queryparamindex);

Default Value

''

Remarks

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.

The $queryparamindex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.

This property is not available at design time.

Data Type

String

RangeCount Property (CloudStorage_AzureFile Class)

The number of records in the Range arrays.

Object Oriented Interface

public function getRangeCount();

Procedural Interface

cloudstorage_azurefile_get($res, 47 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• RangeFirst
• RangeLast

The array indices start at 0 and end at RangeCount - 1.

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

Data Type

Integer

RangeFirst Property (CloudStorage_AzureFile Class)

The first byte of the range.

Object Oriented Interface

public function getRangeFirst($rangeindex);

Procedural Interface

cloudstorage_azurefile_get($res, 48 , $rangeindex);

Default Value

0

Remarks

The first byte of the range.

This property specifies the first byte (inclusive) of the byte range.

The $rangeindex parameter specifies the index of the item in the array. The size of the array is controlled by the RangeCount property.

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

Data Type

Long64

RangeLast Property (CloudStorage_AzureFile Class)

The last byte of the range.

Object Oriented Interface

public function getRangeLast($rangeindex);

Procedural Interface

cloudstorage_azurefile_get($res, 49 , $rangeindex);

Default Value

0

Remarks

The last byte of the range.

This property specifies the last byte (inclusive) of the byte range.

The $rangeindex parameter specifies the index of the item in the array. The size of the array is controlled by the RangeCount property.

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

Data Type

Long64

ResourceData Property (CloudStorage_AzureFile Class)

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

Object Oriented Interface

public function getResourceData();


public function setResourceData($value);

Procedural Interface

cloudstorage_azurefile_get($res, 50 );


cloudstorage_azurefile_set($res, 50, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

ResourceMarker Property (CloudStorage_AzureFile Class)

A marker indicating what page of resources to return next.

Object Oriented Interface

public function getResourceMarker();


public function setResourceMarker($value);

Procedural Interface

cloudstorage_azurefile_get($res, 51 );


cloudstorage_azurefile_set($res, 51, $value );

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.

Data Type

String

ResourceCount Property (CloudStorage_AzureFile Class)

The number of records in the Resource arrays.

Object Oriented Interface

public function getResourceCount();

Procedural Interface

cloudstorage_azurefile_get($res, 52 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ResourceContentMD5
• ResourceContentType
• ResourceETag
• ResourceModifiedTime
• ResourceName
• ResourcePath
• ResourceShare
• ResourceSize
• ResourceType

The array indices start at 0 and end at ResourceCount - 1.

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

Data Type

Integer

ResourceContentMD5 Property (CloudStorage_AzureFile Class)

An MD5 hash of the file's content.

Object Oriented Interface

public function getResourceContentMD5($resourceindex);

Procedural Interface

cloudstorage_azurefile_get($res, 53 , $resourceindex);

Default Value

''

Remarks

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.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourceContentType Property (CloudStorage_AzureFile Class)

The content type of the resource.

Object Oriented Interface

public function getResourceContentType($resourceindex);

Procedural Interface

cloudstorage_azurefile_get($res, 54 , $resourceindex);

Default Value

''

Remarks

The content type of the resource.

This property reflects the content type of the resource.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourceETag Property (CloudStorage_AzureFile Class)

The ETag of the resource.

Object Oriented Interface

public function getResourceETag($resourceindex);

Procedural Interface

cloudstorage_azurefile_get($res, 55 , $resourceindex);

Default Value

''

Remarks

The ETag of the resource.

This property reflects the ETag of the resource.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourceModifiedTime Property (CloudStorage_AzureFile Class)

The last modified time of the resource.

Object Oriented Interface

public function getResourceModifiedTime($resourceindex);

Procedural Interface

cloudstorage_azurefile_get($res, 56 , $resourceindex);

Default Value

''

Remarks

The last modified time of the resource.

This property reflects the last modified time of the resource, formatted according to RFC 1233.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourceName Property (CloudStorage_AzureFile Class)

The name of the resource.

Object Oriented Interface

public function getResourceName($resourceindex);

Procedural Interface

cloudstorage_azurefile_get($res, 57 , $resourceindex);

Default Value

''

Remarks

The name of the resource.

This property reflects the name of the resource.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourcePath Property (CloudStorage_AzureFile Class)

The path of the resource.

Object Oriented Interface

public function getResourcePath($resourceindex);

Procedural Interface

cloudstorage_azurefile_get($res, 58 , $resourceindex);

Default Value

''

Remarks

The path of the resource.

This property reflects the path of the resource (not including the name of the share it resides in; see ResourceShare).

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourceShare Property (CloudStorage_AzureFile Class)

The name of the share the resource resides in.

Object Oriented Interface

public function getResourceShare($resourceindex);

Procedural Interface

cloudstorage_azurefile_get($res, 59 , $resourceindex);

Default Value

''

Remarks

The name of the share the resource resides in.

This property reflects the name of the share the resource resides in.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourceSize Property (CloudStorage_AzureFile Class)

The size of the file.

Object Oriented Interface

public function getResourceSize($resourceindex);

Procedural Interface

cloudstorage_azurefile_get($res, 60 , $resourceindex);

Default Value

0

Remarks

The size of the file.

This property reflects the size, in bytes, of the file resource. Always 0 for folders.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

Long64

ResourceType Property (CloudStorage_AzureFile Class)

The resource's type.

Object Oriented Interface

public function getResourceType($resourceindex);

Procedural Interface

cloudstorage_azurefile_get($res, 61 , $resourceindex);

Default Value

0

Remarks

The resource's type.

This property indicates whether the resource is a folder or a file. Possible values are:

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

Integer

Share Property (CloudStorage_AzureFile Class)

Selects a share.

Object Oriented Interface

public function getShare();


public function setShare($value);

Procedural Interface

cloudstorage_azurefile_get($res, 62 );


cloudstorage_azurefile_set($res, 62, $value );

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.

Data Type

String

ShareMarker Property (CloudStorage_AzureFile Class)

A marker indicating what page of shares to return next.

Object Oriented Interface

public function getShareMarker();


public function setShareMarker($value);

Procedural Interface

cloudstorage_azurefile_get($res, 63 );


cloudstorage_azurefile_set($res, 63, $value );

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.

Data Type

String

ShareCount Property (CloudStorage_AzureFile Class)

The number of records in the Share arrays.

Object Oriented Interface

public function getShareCount();

Procedural Interface

cloudstorage_azurefile_get($res, 64 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ShareETag
• ShareModifiedTime
• ShareName
• ShareQuota
• ShareSpaceUsed

The array indices start at 0 and end at ShareCount - 1.

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

Data Type

Integer

ShareETag Property (CloudStorage_AzureFile Class)

The ETag of the share.

Object Oriented Interface

public function getShareETag($shareindex);

Procedural Interface

cloudstorage_azurefile_get($res, 65 , $shareindex);

Default Value

''

Remarks

The ETag of the share.

This property reflects the ETag of the share.

The $shareindex parameter specifies the index of the item in the array. The size of the array is controlled by the ShareCount property.

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

Data Type

String

ShareModifiedTime Property (CloudStorage_AzureFile Class)

The last modified time of the share.

Object Oriented Interface

public function getShareModifiedTime($shareindex);

Procedural Interface

cloudstorage_azurefile_get($res, 66 , $shareindex);

Default Value

''

Remarks

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.

The $shareindex parameter specifies the index of the item in the array. The size of the array is controlled by the ShareCount property.

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

Data Type

String

ShareName Property (CloudStorage_AzureFile Class)

The name of the share.

Object Oriented Interface

public function getShareName($shareindex);

Procedural Interface

cloudstorage_azurefile_get($res, 67 , $shareindex);

Default Value

''

Remarks

The name of the share.

This property reflects the name of the share.

The $shareindex parameter specifies the index of the item in the array. The size of the array is controlled by the ShareCount property.

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

Data Type

String

ShareQuota Property (CloudStorage_AzureFile Class)

The share's space quota, in GB.

Object Oriented Interface

public function getShareQuota($shareindex);

Procedural Interface

cloudstorage_azurefile_get($res, 68 , $shareindex);

Default Value

0

Remarks

The share's space quota, in GB.

This property reflects the space quota, in GB, imposed on the share.

The $shareindex parameter specifies the index of the item in the array. The size of the array is controlled by the ShareCount property.

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

Data Type

Integer

ShareSpaceUsed Property (CloudStorage_AzureFile Class)

The amount of storage space consumed by the share.

Object Oriented Interface

public function getShareSpaceUsed($shareindex);

Procedural Interface

cloudstorage_azurefile_get($res, 69 , $shareindex);

Default Value

0

Remarks

The amount of storage space consumed by the share.

This property reflects the approximate amount of storage space, in GB, the share is consuming.

The $shareindex parameter specifies the index of the item in the array. The size of the array is controlled by the ShareCount property.

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

Data Type

Integer

SSLAcceptServerCertEffectiveDate Property (CloudStorage_AzureFile Class)

This is the date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

cloudstorage_azurefile_get($res, 70 );

Default Value

''

Remarks

This is 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.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (CloudStorage_AzureFile Class)

This is the date the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

cloudstorage_azurefile_get($res, 71 );

Default Value

''

Remarks

This is the date 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.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (CloudStorage_AzureFile Class)

This is a comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

cloudstorage_azurefile_get($res, 72 );

Default Value

''

Remarks

This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (CloudStorage_AzureFile Class)

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

cloudstorage_azurefile_get($res, 73 );

Default Value

''

Remarks

This is 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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (CloudStorage_AzureFile Class)

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

cloudstorage_azurefile_get($res, 74 );

Default Value

''

Remarks

This is 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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (CloudStorage_AzureFile Class)

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

cloudstorage_azurefile_get($res, 75 );

Default Value

''

Remarks

This is 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

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (CloudStorage_AzureFile Class)

This is the issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

cloudstorage_azurefile_get($res, 76 );

Default Value

''

Remarks

This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (CloudStorage_AzureFile Class)

This is the private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

cloudstorage_azurefile_get($res, 77 );

Default Value

''

Remarks

This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (CloudStorage_AzureFile Class)

This property shows whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

cloudstorage_azurefile_get($res, 78 );

Default Value

false

Remarks

This property shows whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (CloudStorage_AzureFile Class)

This is the name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

cloudstorage_azurefile_get($res, 79 );

Default Value

''

Remarks

This is the name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (CloudStorage_AzureFile Class)

This is the public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

cloudstorage_azurefile_get($res, 80 );

Default Value

''

Remarks

This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (CloudStorage_AzureFile Class)

This property contains the textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

cloudstorage_azurefile_get($res, 81 );

Default Value

''

Remarks

This property contains 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.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (CloudStorage_AzureFile Class)

This is the length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

cloudstorage_azurefile_get($res, 82 );

Default Value

0

Remarks

This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (CloudStorage_AzureFile Class)

This is the serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

cloudstorage_azurefile_get($res, 83 );

Default Value

''

Remarks

This is 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.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (CloudStorage_AzureFile Class)

The property contains the text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

cloudstorage_azurefile_get($res, 84 );

Default Value

''

Remarks

The property contains 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.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (CloudStorage_AzureFile Class)

This is the name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();


public function setSSLAcceptServerCertStore($value);

Procedural Interface

cloudstorage_azurefile_get($res, 85 );


cloudstorage_azurefile_set($res, 85, $value );

Default Value

'MY'

Remarks

This is the name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (CloudStorage_AzureFile Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLAcceptServerCertStorePassword();


public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

cloudstorage_azurefile_get($res, 86 );


cloudstorage_azurefile_set($res, 86, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLAcceptServerCertStoreType Property (CloudStorage_AzureFile Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();


public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

cloudstorage_azurefile_get($res, 87 );


cloudstorage_azurefile_set($res, 87, $value );

Default Value

0

Remarks

This is 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:

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (CloudStorage_AzureFile Class)

This property contains comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

cloudstorage_azurefile_get($res, 88 );

Default Value

''

Remarks

This property contains comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (CloudStorage_AzureFile Class)

This property contains the MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

cloudstorage_azurefile_get($res, 89 );

Default Value

''

Remarks

This property contains 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.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (CloudStorage_AzureFile Class)

This property contains the SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

cloudstorage_azurefile_get($res, 90 );

Default Value

''

Remarks

This property contains 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.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (CloudStorage_AzureFile Class)

This property contains the SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

cloudstorage_azurefile_get($res, 91 );

Default Value

''

Remarks

This property contains 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.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (CloudStorage_AzureFile Class)

This property contains the text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

cloudstorage_azurefile_get($res, 92 );

Default Value

''

Remarks

This property contains the text description of SSLAcceptServerCertUsageFlags.

This value will be of 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.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (CloudStorage_AzureFile Class)

This property contains the flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

cloudstorage_azurefile_get($res, 93 );

Default Value

0

Remarks

This property contains the flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (CloudStorage_AzureFile Class)

This property contains the certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

cloudstorage_azurefile_get($res, 94 );

Default Value

''

Remarks

This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (CloudStorage_AzureFile Class)

This is the subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();


public function setSSLAcceptServerCertSubject($value);

Procedural Interface

cloudstorage_azurefile_get($res, 95 );


cloudstorage_azurefile_set($res, 95, $value );

Default Value

''

Remarks

This is 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=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLAcceptServerCertEncoded Property (CloudStorage_AzureFile Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

cloudstorage_azurefile_get($res, 96 );


cloudstorage_azurefile_set($res, 96, $value );

Default Value

''

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (CloudStorage_AzureFile Class)

This is the date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

cloudstorage_azurefile_get($res, 97 );

Default Value

''

Remarks

This is 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.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (CloudStorage_AzureFile Class)

This is the date the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

cloudstorage_azurefile_get($res, 98 );

Default Value

''

Remarks

This is the date 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.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (CloudStorage_AzureFile Class)

This is a comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

cloudstorage_azurefile_get($res, 99 );

Default Value

''

Remarks

This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (CloudStorage_AzureFile Class)

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

cloudstorage_azurefile_get($res, 100 );

Default Value

''

Remarks

This is 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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (CloudStorage_AzureFile Class)

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

cloudstorage_azurefile_get($res, 101 );

Default Value

''

Remarks

This is 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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (CloudStorage_AzureFile Class)

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

cloudstorage_azurefile_get($res, 102 );

Default Value

''

Remarks

This is 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

This property is read-only.

Data Type

String

SSLCertIssuer Property (CloudStorage_AzureFile Class)

This is the issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

cloudstorage_azurefile_get($res, 103 );

Default Value

''

Remarks

This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (CloudStorage_AzureFile Class)

This is the private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

cloudstorage_azurefile_get($res, 104 );

Default Value

''

Remarks

This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (CloudStorage_AzureFile Class)

This property shows whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

cloudstorage_azurefile_get($res, 105 );

Default Value

false

Remarks

This property shows whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (CloudStorage_AzureFile Class)

This is the name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

cloudstorage_azurefile_get($res, 106 );

Default Value

''

Remarks

This is the name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (CloudStorage_AzureFile Class)

This is the public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

cloudstorage_azurefile_get($res, 107 );

Default Value

''

Remarks

This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (CloudStorage_AzureFile Class)

This property contains the textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

cloudstorage_azurefile_get($res, 108 );

Default Value

''

Remarks

This property contains 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.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (CloudStorage_AzureFile Class)

This is the length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

cloudstorage_azurefile_get($res, 109 );

Default Value

0

Remarks

This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (CloudStorage_AzureFile Class)

This is the serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

cloudstorage_azurefile_get($res, 110 );

Default Value

''

Remarks

This is 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.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (CloudStorage_AzureFile Class)

The property contains the text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

cloudstorage_azurefile_get($res, 111 );

Default Value

''

Remarks

The property contains 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.

This property is read-only.

Data Type

String

SSLCertStore Property (CloudStorage_AzureFile Class)

This is the name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

cloudstorage_azurefile_get($res, 112 );


cloudstorage_azurefile_set($res, 112, $value );

Default Value

'MY'

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (CloudStorage_AzureFile Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface

cloudstorage_azurefile_get($res, 113 );


cloudstorage_azurefile_set($res, 113, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (CloudStorage_AzureFile Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

cloudstorage_azurefile_get($res, 114 );


cloudstorage_azurefile_set($res, 114, $value );

Default Value

0

Remarks

This is 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:

Data Type

Integer

SSLCertSubjectAltNames Property (CloudStorage_AzureFile Class)

This property contains comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

cloudstorage_azurefile_get($res, 115 );

Default Value

''

Remarks

This property contains comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (CloudStorage_AzureFile Class)

This property contains the MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

cloudstorage_azurefile_get($res, 116 );

Default Value

''

Remarks

This property contains 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.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (CloudStorage_AzureFile Class)

This property contains the SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

cloudstorage_azurefile_get($res, 117 );

Default Value

''

Remarks

This property contains 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.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (CloudStorage_AzureFile Class)

This property contains the SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

cloudstorage_azurefile_get($res, 118 );

Default Value

''

Remarks

This property contains 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.

This property is read-only.

Data Type

String

SSLCertUsage Property (CloudStorage_AzureFile Class)

This property contains the text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

cloudstorage_azurefile_get($res, 119 );

Default Value

''

Remarks

This property contains the text description of SSLCertUsageFlags.

This value will be of 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.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (CloudStorage_AzureFile Class)

This property contains the flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

cloudstorage_azurefile_get($res, 120 );

Default Value

0

Remarks

This property contains the flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (CloudStorage_AzureFile Class)

This property contains the certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

cloudstorage_azurefile_get($res, 121 );

Default Value

''

Remarks

This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (CloudStorage_AzureFile Class)

This is the subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

cloudstorage_azurefile_get($res, 122 );


cloudstorage_azurefile_set($res, 122, $value );

Default Value

''

Remarks

This is 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=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLCertEncoded Property (CloudStorage_AzureFile Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

cloudstorage_azurefile_get($res, 123 );


cloudstorage_azurefile_set($res, 123, $value );

Default Value

''

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (CloudStorage_AzureFile Class)

This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

cloudstorage_azurefile_get($res, 124 );


cloudstorage_azurefile_set($res, 124, $value );

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:

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, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEffectiveDate Property (CloudStorage_AzureFile Class)

This is the date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

cloudstorage_azurefile_get($res, 125 );

Default Value

''

Remarks

This is 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.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (CloudStorage_AzureFile Class)

This is the date the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

cloudstorage_azurefile_get($res, 126 );

Default Value

''

Remarks

This is the date 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.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (CloudStorage_AzureFile Class)

This is a comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

cloudstorage_azurefile_get($res, 127 );

Default Value

''

Remarks

This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (CloudStorage_AzureFile Class)

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

cloudstorage_azurefile_get($res, 128 );

Default Value

''

Remarks

This is 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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (CloudStorage_AzureFile Class)

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

cloudstorage_azurefile_get($res, 129 );

Default Value

''

Remarks

This is 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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (CloudStorage_AzureFile Class)

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

cloudstorage_azurefile_get($res, 130 );

Default Value

''

Remarks

This is 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

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (CloudStorage_AzureFile Class)

This is the issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

cloudstorage_azurefile_get($res, 131 );

Default Value

''

Remarks

This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (CloudStorage_AzureFile Class)

This is the private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

cloudstorage_azurefile_get($res, 132 );

Default Value

''

Remarks

This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (CloudStorage_AzureFile Class)

This property shows whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

cloudstorage_azurefile_get($res, 133 );

Default Value

false

Remarks

This property shows whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (CloudStorage_AzureFile Class)

This is the name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

cloudstorage_azurefile_get($res, 134 );

Default Value

''

Remarks

This is the name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (CloudStorage_AzureFile Class)

This is the public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

cloudstorage_azurefile_get($res, 135 );

Default Value

''

Remarks

This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (CloudStorage_AzureFile Class)

This property contains the textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

cloudstorage_azurefile_get($res, 136 );

Default Value

''

Remarks

This property contains 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.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (CloudStorage_AzureFile Class)

This is the length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

cloudstorage_azurefile_get($res, 137 );

Default Value

0

Remarks

This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (CloudStorage_AzureFile Class)

This is the serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

cloudstorage_azurefile_get($res, 138 );

Default Value

''

Remarks

This is 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.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (CloudStorage_AzureFile Class)

The property contains the text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

cloudstorage_azurefile_get($res, 139 );

Default Value

''

Remarks

The property contains 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.

This property is read-only.

Data Type

String

SSLServerCertStore Property (CloudStorage_AzureFile Class)

This is the name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

cloudstorage_azurefile_get($res, 140 );

Default Value

'MY'

Remarks

This is the name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (CloudStorage_AzureFile Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

cloudstorage_azurefile_get($res, 141 );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (CloudStorage_AzureFile Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

cloudstorage_azurefile_get($res, 142 );

Default Value

0

Remarks

This is 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:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (CloudStorage_AzureFile Class)

This property contains comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

cloudstorage_azurefile_get($res, 143 );

Default Value

''

Remarks

This property contains comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (CloudStorage_AzureFile Class)

This property contains the MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

cloudstorage_azurefile_get($res, 144 );

Default Value

''

Remarks

This property contains 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.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (CloudStorage_AzureFile Class)

This property contains the SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

cloudstorage_azurefile_get($res, 145 );

Default Value

''

Remarks

This property contains 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.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (CloudStorage_AzureFile Class)

This property contains the SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

cloudstorage_azurefile_get($res, 146 );

Default Value

''

Remarks

This property contains 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.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (CloudStorage_AzureFile Class)

This property contains the text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

cloudstorage_azurefile_get($res, 147 );

Default Value

''

Remarks

This property contains the text description of SSLServerCertUsageFlags.

This value will be of 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.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (CloudStorage_AzureFile Class)

This property contains the flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

cloudstorage_azurefile_get($res, 148 );

Default Value

0

Remarks

This property contains the flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (CloudStorage_AzureFile Class)

This property contains the certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

cloudstorage_azurefile_get($res, 149 );

Default Value

''

Remarks

This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (CloudStorage_AzureFile Class)

This is the subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

cloudstorage_azurefile_get($res, 150 );

Default Value

''

Remarks

This is 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=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (CloudStorage_AzureFile Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

cloudstorage_azurefile_get($res, 151 );

Default Value

''

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

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

Data Type

Binary String

StartByte Property (CloudStorage_AzureFile Class)

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

Object Oriented Interface

public function getStartByte();


public function setStartByte($value);

Procedural Interface

cloudstorage_azurefile_get($res, 152 );


cloudstorage_azurefile_set($res, 152, $value );

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 and DownloadFile for details about resuming uploads and downloads.

This property is not available at design time.

Data Type

Long64

Timeout Property (CloudStorage_AzureFile Class)

This property includes the timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

cloudstorage_azurefile_get($res, 153 );


cloudstorage_azurefile_set($res, 153, $value );

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 fails with an error.

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.

Data Type

Integer

UseSSL Property (CloudStorage_AzureFile Class)

Whether to use SSL/TLS when connecting.

Object Oriented Interface

public function getUseSSL();


public function setUseSSL($value);

Procedural Interface

cloudstorage_azurefile_get($res, 154 );


cloudstorage_azurefile_set($res, 154, $value );

Default Value

true

Remarks

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

This property is not available at design time.

Data Type

Boolean

AbortCopy Method (CloudStorage_AzureFile Class)

Aborts a copy operation.

Object Oriented Interface

public function doAbortCopy($destfilepath, $copyid);

Procedural Interface

cloudstorage_azurefile_do_abortcopy($res, $destfilepath, $copyid);

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 (CloudStorage_AzureFile Class)

Adds a metadata item to the Metadata properties.

Object Oriented Interface

public function doAddMetadata($name, $value);

Procedural Interface

cloudstorage_azurefile_do_addmetadata($res, $name, $value);

Remarks

This method adds a metadata item to the Metadata properties. 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.

AddQueryParam Method (CloudStorage_AzureFile Class)

Adds a query parameter to the QueryParams properties.

Object Oriented Interface

public function doAddQueryParam($name, $value);

Procedural Interface

cloudstorage_azurefile_do_addqueryparam($res, $name, $value);

Remarks

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

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

Authorize Method (CloudStorage_AzureFile Class)

Get the authorization string required to access the protected resource.

Object Oriented Interface

public function doAuthorize();

Procedural Interface

cloudstorage_azurefile_do_authorize($res);

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 property. It should instead be used when setting the OAuth property.

For more information, see the introduction section.

ClearRange Method (CloudStorage_AzureFile Class)

Clears a range of bytes from a file.

Object Oriented Interface

public function doClearRange($filepath, $first, $last);

Procedural Interface

cloudstorage_azurefile_do_clearrange($res, $filepath, $first, $last);

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 (CloudStorage_AzureFile Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

cloudstorage_azurefile_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings 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, you must call Config("PROPERTY"). The value will be returned as a string.

CopyFile Method (CloudStorage_AzureFile Class)

Copies a file.

Object Oriented Interface

public function doCopyFile($fromfilepath, $tofilepath, $toshare);

Procedural Interface

cloudstorage_azurefile_do_copyfile($res, $fromfilepath, $tofilepath, $toshare);

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 (CloudStorage_AzureFile Class)

Initializes a new file.

Object Oriented Interface

public function doCreateFile($newfilepath, $filelength);

Procedural Interface

cloudstorage_azurefile_do_createfile($res, $newfilepath, $filelength);

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 properties 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 (CloudStorage_AzureFile Class)

Creates a new folder.

Object Oriented Interface

public function doCreateFolder($newfolderpath);

Procedural Interface

cloudstorage_azurefile_do_createfolder($res, $newfolderpath);

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 properties will be sent along with the creation request.

CreateShare Method (CloudStorage_AzureFile Class)

Creates a new share.

Object Oriented Interface

public function doCreateShare();

Procedural Interface

cloudstorage_azurefile_do_createshare($res);

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 properties 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.)
• All hyphens must be immediately preceded and followed by a letter or number (consecutive hyphens are not allowed).

DeleteFile Method (CloudStorage_AzureFile Class)

Deletes a file.

Object Oriented Interface

public function doDeleteFile($filepath);

Procedural Interface

cloudstorage_azurefile_do_deletefile($res, $filepath);

Remarks

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

DeleteFolder Method (CloudStorage_AzureFile Class)

Deletes a folder.

Object Oriented Interface

public function doDeleteFolder($folderpath);

Procedural Interface

cloudstorage_azurefile_do_deletefolder($res, $folderpath);

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 (CloudStorage_AzureFile Class)

Deletes a share.

Object Oriented Interface

public function doDeleteShare();

Procedural Interface

cloudstorage_azurefile_do_deleteshare($res);

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 (CloudStorage_AzureFile Class)

Downloads a file.

Object Oriented Interface

public function doDownloadFile($filepath);

Procedural Interface

cloudstorage_azurefile_do_downloadfile($res, $filepath);

Remarks

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

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

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

Download Notes

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

Resuming Downloads

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

Resuming Encrypted File Downloads

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

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

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

GetFileInfo Method (CloudStorage_AzureFile Class)

Gets a file's information and metadata.

Object Oriented Interface

public function doGetFileInfo($filepath);

Procedural Interface

cloudstorage_azurefile_do_getfileinfo($res, $filepath);

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 properties with a single item, and will re-populate the Metadata properties with any metadata currently associated with the file.

GetFolderInfo Method (CloudStorage_AzureFile Class)

Gets a folder's information and metadata.

Object Oriented Interface

public function doGetFolderInfo($folderpath);

Procedural Interface

cloudstorage_azurefile_do_getfolderinfo($res, $folderpath);

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 properties with a single item, and will re-populate the Metadata properties with any metadata currently associated with the folder.

GetLink Method (CloudStorage_AzureFile Class)

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

Object Oriented Interface

public function doGetLink($filepath, $permissions, $starttime, $expirytime);

Procedural Interface

cloudstorage_azurefile_do_getlink($res, $filepath, $permissions, $starttime, $expirytime);

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

If any of the query parameters listed below are present in the QueryParams properties 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 (CloudStorage_AzureFile Class)

Gets the list of allocated data ranges in a file.

Object Oriented Interface

public function doGetRanges($filepath);

Procedural Interface

cloudstorage_azurefile_do_getranges($res, $filepath);

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 properties 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 (CloudStorage_AzureFile Class)

Gets a share's information and metadata.

Object Oriented Interface

public function doGetShareInfo();

Procedural Interface

cloudstorage_azurefile_do_getshareinfo($res);

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 properties with a single item, and will re-populate the Metadata properties with any metadata currently associated with the share.

Interrupt Method (CloudStorage_AzureFile Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

cloudstorage_azurefile_do_interrupt($res);

Remarks

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

ListResources Method (CloudStorage_AzureFile Class)

Lists resources in a given folder.

Object Oriented Interface

public function doListResources($folderpath);

Procedural Interface

cloudstorage_azurefile_do_listresources($res, $folderpath);

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

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

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

• ResourceName
• ResourcePath (populated by the class automatically)
• ResourceShare (populated by the class automatically)
• ResourceSize
• ResourceType

ListShares Method (CloudStorage_AzureFile Class)

Lists shares in the file storage account.

Object Oriented Interface

public function doListShares();

Procedural Interface

cloudstorage_azurefile_do_listshares($res);

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

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

Note that the server does not return the shares' ShareSpaceUsed property when listing shares; use GetShareInfo to retrieve all properties 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 (CloudStorage_AzureFile Class)

Uploads a range of data to a file.

Object Oriented Interface

public function doPutRange($filepath, $writeoffset);

Procedural Interface

cloudstorage_azurefile_do_putrange($res, $filepath, $writeoffset);

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 (CloudStorage_AzureFile Class)

Renames a file.

Object Oriented Interface

public function doRenameFile($oldfilepath, $newfilepath);

Procedural Interface

cloudstorage_azurefile_do_renamefile($res, $oldfilepath, $newfilepath);

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 (CloudStorage_AzureFile Class)

Renames a directory.

Object Oriented Interface

public function doRenameFolder($olddirpath, $newdirpath);

Procedural Interface

cloudstorage_azurefile_do_renamefolder($res, $olddirpath, $newdirpath);

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 (CloudStorage_AzureFile Class)

Resets the class to its initial state.

Object Oriented Interface

public function doReset();

Procedural Interface

cloudstorage_azurefile_do_reset($res);

Remarks

This method resets the class to its initial state.

ResizeFile Method (CloudStorage_AzureFile Class)

Resizes a file.

Object Oriented Interface

public function doResizeFile($filepath, $newsize);

Procedural Interface

cloudstorage_azurefile_do_resizefile($res, $filepath, $newsize);

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.

SetShareQuota Method (CloudStorage_AzureFile Class)

Sets a share's space quota.

Object Oriented Interface

public function doSetShareQuota($quota);

Procedural Interface

cloudstorage_azurefile_do_setsharequota($res, $quota);

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.

UpdateMetadata Method (CloudStorage_AzureFile Class)

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

Object Oriented Interface

public function doUpdateMetadata($path, $resourcetype);

Procedural Interface

cloudstorage_azurefile_do_updatemetadata($res, $path, $resourcetype);

Remarks

This method sets the metadata for a file, folder, or share to the items currently held by the Metadata properties. 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.
• 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 (CloudStorage_AzureFile Class)

Uploads a new file resource.

Object Oriented Interface

public function doUploadFile($newfilepath);

Procedural Interface

cloudstorage_azurefile_do_uploadfile($res, $newfilepath);

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 properties will be sent along with the creation request.

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

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

Upload Notes

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

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

If the upload is interrupted for any reason, resuming it is easy. First, verify that StartByte is populated (if the same instance of the class is used, they should already be populated, and no special action should be needed). Then call UploadFile again to resume the upload at the specified StartByte offset. azurefile.LocalFile = "../MyFile.zip"; azurefile.UploadFile("MyFile.zip"); //The transfer is interrupted and UploadFile() above fails. Later, resume the download. //Using the same instance StartByte is already populated from the previous upload attempt. azurefile.UploadFile("MyFile.zip");

EndTransfer Event (CloudStorage_AzureFile Class)

This event fires when a document finishes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

cloudstorage_azurefile_register_callback($res, 1, array($this, 'fireEndTransfer'));

Parameter List

 'direction'

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 (CloudStorage_AzureFile Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

cloudstorage_azurefile_register_callback($res, 2, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

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 (CloudStorage_AzureFile Class)

Fires after each fragment of a resumable upload is completed.

Object Oriented Interface

public function fireFragmentComplete($param);

Procedural Interface

cloudstorage_azurefile_register_callback($res, 3, array($this, 'fireFragmentComplete'));

Parameter List

 'fragmentnumber'
 'fragmentcount'
 'interrupt'

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 (CloudStorage_AzureFile Class)

This event is fired every time a header line comes in.

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

cloudstorage_azurefile_register_callback($res, 4, array($this, 'fireHeader'));

Parameter List

 'field'
 'value'

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 (CloudStorage_AzureFile Class)

This event fires once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

cloudstorage_azurefile_register_callback($res, 5, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

Remarks

This event fires once for each log message generated by the class. 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 (CloudStorage_AzureFile Class)

Fires during an upload or download to indicate transfer progress.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

cloudstorage_azurefile_register_callback($res, 6, array($this, 'fireProgress'));

Parameter List

 'direction'
 'bytestransferred'
 'totalbytes'
 'percentdone'

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

ResourceList Event (CloudStorage_AzureFile Class)

Fires once for each resource returned when listing resources.

Object Oriented Interface

public function fireResourceList($param);

Procedural Interface

cloudstorage_azurefile_register_callback($res, 7, array($this, 'fireResourceList'));

Parameter List

 'name'
 'path'
 'share'
 'resourcetype'
 'modifiedtime'
 'size'
 'etag'

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 (CloudStorage_AzureFile Class)

Fires once for each share returned when listing shares.

Object Oriented Interface

public function fireShareList($param);

Procedural Interface

cloudstorage_azurefile_register_callback($res, 8, array($this, 'fireShareList'));

Parameter List

 'name'
 'modifiedtime'
 'etag'
 'quota'

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 (CloudStorage_AzureFile Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

cloudstorage_azurefile_register_callback($res, 9, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

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 (CloudStorage_AzureFile Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

cloudstorage_azurefile_register_callback($res, 10, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

StartTransfer Event (CloudStorage_AzureFile Class)

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

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

cloudstorage_azurefile_register_callback($res, 11, array($this, 'fireStartTransfer'));

Parameter List

 'direction'

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 (CloudStorage_AzureFile Class)

This event is fired while a document transfers (delivers document).

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

cloudstorage_azurefile_register_callback($res, 12, array($this, 'fireTransfer'));

Parameter List

 'direction'
 'bytestransferred'
 'percentdone'
 'text'

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.

Config Settings (AzureFile Class)

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

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermedaite Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

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