AzureBlob Class

Properties   Methods   Events   Config Settings   Errors  

The AzureBlob class provides an easy to use interface to Microsoft's Azure Blob Storage service.

Class Name

CloudStorage_AzureBlob

Procedural Interface

 cloudstorage_azureblob_open();
 cloudstorage_azureblob_close($res);
 cloudstorage_azureblob_register_callback($res, $id, $function);
 cloudstorage_azureblob_get_last_error($res);
 cloudstorage_azureblob_get_last_error_code($res);
 cloudstorage_azureblob_set($res, $id, $index, $value);
 cloudstorage_azureblob_get($res, $id, $index);
 cloudstorage_azureblob_do_abortcopy($res, $destblob, $copyid);
 cloudstorage_azureblob_do_addblock($res, $id, $blocklisttype);
 cloudstorage_azureblob_do_addmetadata($res, $name, $value);
 cloudstorage_azureblob_do_addqueryparam($res, $name, $value);
 cloudstorage_azureblob_do_appendblock($res, $appendblob);
 cloudstorage_azureblob_do_authorize($res);
 cloudstorage_azureblob_do_calcauthorization($res);
 cloudstorage_azureblob_do_clearpages($res, $pageblob, $byteoffset, $pagecount);
 cloudstorage_azureblob_do_config($res, $configurationstring);
 cloudstorage_azureblob_do_copyblob($res, $srcblob, $destblob, $destcontainer);
 cloudstorage_azureblob_do_createblob($res, $blob, $blobtype, $pageblobsize);
 cloudstorage_azureblob_do_createcontainer($res);
 cloudstorage_azureblob_do_createsnapshot($res, $blob);
 cloudstorage_azureblob_do_deleteblob($res, $blob, $deleteaction);
 cloudstorage_azureblob_do_deletecontainer($res);
 cloudstorage_azureblob_do_getblob($res, $blob);
 cloudstorage_azureblob_do_getblobinfo($res, $blob);
 cloudstorage_azureblob_do_getcontaineracl($res);
 cloudstorage_azureblob_do_getcontainerinfo($res);
 cloudstorage_azureblob_do_getlink($res, $blob, $permissions, $starttime, $expirytime);
 cloudstorage_azureblob_do_getuserdelegationkey($res, $starttime, $expirytime);
 cloudstorage_azureblob_do_interrupt($res);
 cloudstorage_azureblob_do_lease($res, $blob, $leaseaction, $newleaseid, $duration);
 cloudstorage_azureblob_do_listblobs($res);
 cloudstorage_azureblob_do_listblocks($res, $blockblob, $blocklisttype);
 cloudstorage_azureblob_do_listcontainers($res);
 cloudstorage_azureblob_do_listpageranges($res, $pageblob);
 cloudstorage_azureblob_do_putblock($res, $blockblob, $blockid);
 cloudstorage_azureblob_do_putblocklist($res, $blockblob, $blocklist);
 cloudstorage_azureblob_do_putpages($res, $pageblob, $writeoffset);
 cloudstorage_azureblob_do_reset($res);
 cloudstorage_azureblob_do_sendcustomrequest($res, $httpmethod, $blob, $requestbody);
 cloudstorage_azureblob_do_setcontaineracl($res, $publicaccess);
 cloudstorage_azureblob_do_undeleteblob($res, $blob);
 cloudstorage_azureblob_do_undeletecontainer($res, $container, $deletedversion);
 cloudstorage_azureblob_do_updateblobinfo($res, $blob);
 cloudstorage_azureblob_do_updatemetadata($res, $blob);
 cloudstorage_azureblob_do_updatepageblob($res, $pageblob, $newsize, $sequencenumaction, $newsequencenum);

Remarks

The AzureBlob class offers an easy-to-use API for the Microsoft Azure Blob Storage service. Capabilities include uploading and downloading blobs of all types, strong encryption support, container management, and more.

Authentication

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

Alternatively, this class supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth property to set the appropriate fields for the chosen OAuthClientProfile and OAuthGrantType. Typically, the following fields should be set to the below values:

Below is a brief description of the different OAuthClientProfile and OAuthGrantType values that are supported by this class. For a more in-depth description of what needs to be set, refer to the service documentation.

Application Profile

This profile encompasses the most basic grant types that OAuth supports. When this profile is set, all the requests and response handling is done by the class. Depending on the grant type, this may involve launching a browser so a user can login to authenticate with a authorization server. It may also involve starting an embedded web server to receive a response from a redirect.

To start the authentication and authorization process, the Authorize method should be called. If the authorization and authentication was successful, then the OAuthAccessToken property will be populated. Additionally, if a refresh token was provided the OAuthRefreshToken property will be populated as well. These values of the fields are for informational purposes. The class will also cache these tokens along with when the OAuthAccessToken will be expired. When a method that makes requests to the service provider is called or the Authorize method is called the class will automatically check to see if the access token is expired. If it is, it will then automatically try to get a new OAuthAccessToken. If the Authorize method was not used and user interaction would be required, the class will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the OAuthGrantType property. To force the component to only check the access token when the Authorize method is called, the OAuthAutomaticRefresh configuration setting can be set to false.

A brief description of the supported values for the OAuthGrantType property are below. For more information, see the service documentation.

Authorization Code

When using the Authorization Code grant type, the class will use an authorization code to get an access token. For this OAuthGrantType the class expects a OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, and OAuthServerTokenURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the authorization code, setting the OAuthAuthorizationCode property, from the redirect. Immediately, the class will make a request to the token server to exchange the authorization code for an access token. The token server will return an access token and possibly a refresh token. If the OAuthRefreshToken property is set, or a refresh token is cached, then the class will not launch the browser and use the refresh token in its request to the token server instead of an authorization code.

blob.OAuth.ClientProfile = CloudOAuthClientProfiles.cocpApplication; blob.OAuth.GrantType = OAuthSettingsGrantTypes.cogtAuthorizationCode; blob.OAuth.ClientId = CLIENT_ID; blob.OAuth.ClientSecret = CLIENT_SECRET; blob.OAuth.AuthorizationScope = "https://{ACCOUNT}.blob.core.windows.net/user_impersonation"; blob.OAuth.ServerAuthURL = "https://login.microsoftonline.com/{TENANT_ID}/oauth2/v2.0/authorize"; blob.OAuth.ServerTokenURL = "https://login.microsoftonline.com/{TENANT_ID}/oauth2/v2.0/token"; blob.Authorize();

Implicit

Note: This grant type is considered insecure and should only be used when necessary.

When using the Implicit grant type, the class will request the authorization server to get an access token. For this OAuthGrantType the class expects a OAuthClientId, OAuthClientSecret, and OAuthServerAuthURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the access token from the redirect.

A disadvantage of the grant type is that can not use a refresh token to silently get a new access token. Most service providers offer a way to silently get a new access token. See the service documentation for specifics. This means the class will not be able to automatically get a fresh token once it expires.

Password

Note: This grant type is considered insecure and should only be used when necessary.

When using the Resource Owner Password Credentials grant type, the class will authenticate as the resource owner. This allows for the class to avoid user interaction. This grant type often has specific limitations put on it by the service provider. See the service documentation for more details.

For this OAuthGrantType the class requires OAuthPasswordGrantUsername, OAuthClientSecret, and OAuthServerTokenURL to be set. The OAuthClientSecret should be set to the password of the account instead of a typical secret. In some cases, the OAuthClientId also needs to be set. When the Authorize method is called, the component will make a request to the token server for an access token using the username and password. The token server will return an access token if the authentication was successful. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.

Web Profile

This profile is similar to setting the class to the Application profile and Authorization Code grant type except the class will not launch the browser. It is typically used in situations where there is a back-end that is supporting some front end. This profile expects that OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, OAuthServerTokenURL, and the OAuthReturnURL properties to be set. Before calling the Authorize method, the OAuthWebAuthURL property should be queried to get a URL. This URL should be used to redirect the user to the authorization page for the service provider. The redirect_uri parameter of this URL is mapped to the OAuthReturnURL property. The OAuthReturnURL property should be set to some web server that will parse the authorization code out of the query parameter from the redirect. Once the authorization code is parsed, it should be passed back to the server where it is then set to the OAuthAuthorizationCode property. Once that is set, the Authorize method can be called to exchange the authorization code for an access token and refresh token if provided. The class will then cache these values like normal and use them to make requests. If the OAuthRefreshToken field is set, or a refresh token is cached, then the Authorize method can immediately be called to make a request to the token server to get a new access token.

External OAuth Support

For complex profiles or grant types, or for more control of the flow, it is possible to perform OAuth authentication using the OAuth class or a separate process. Once complete you should have an authorization string which looks like:

Bearer ACCESS_TOKEN_VALUE

Assign this value to the Authorization property before attempting any operations. Setting the Authorization property will cause the class to ignore the values set in the OAuth property.

Consult the Azure Blob Storage service's documentation for more information about using OAuth authentication.

Usage

Once authenticated, you can start interacting with the Azure Blob Storage service. The following list shows some of the methods used to accomplish common tasks:

• Container management: ListContainers, GetContainerInfo, CreateContainer, DeleteContainer, GetContainerACL, SetContainerACL
• Blob management: ListBlobs, GetBlobInfo, UpdateBlobInfo, CreateBlob, CopyBlob, GetBlob, DeleteBlob, UndeleteBlob
• Block blob management: ListBlocks, PutBlock, PutBlockList
• Page blob management: ListPageRanges, PutPages, ClearPages, UpdatePageBlob
• Append blob management: AppendBlock

The class support much more than just the functionality described above; refer to the complete API, below, for more information.

Property List

---

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

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_AzureBlob Class)

The Azure access key to use for authentication.

Object Oriented Interface

public function getAccessKey();
public function setAccessKey($value);

Procedural Interface

cloudstorage_azureblob_get($res, 1 );
cloudstorage_azureblob_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.

Note: this property's value is ignored if the Authorization property is populated.

This property is not available at design time.

Data Type

String

AccessPolicyCount Property (CloudStorage_AzureBlob Class)

The number of records in the AccessPolicy arrays.

Object Oriented Interface

public function getAccessPolicyCount();
public function setAccessPolicyCount($value);

Procedural Interface

cloudstorage_azureblob_get($res, 2 );
cloudstorage_azureblob_set($res, 2, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• AccessPolicyExpiryTime
• AccessPolicyId
• AccessPolicyPermissions
• AccessPolicyStartTime

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

This property is not available at design time.

Data Type

Integer

AccessPolicyExpiryTime Property (CloudStorage_AzureBlob Class)

The expiry time of the access policy.

Object Oriented Interface

public function getAccessPolicyExpiryTime($accesspolicyindex);
public function setAccessPolicyExpiryTime($accesspolicyindex, $value);

Procedural Interface

cloudstorage_azureblob_get($res, 3 , $accesspolicyindex);
cloudstorage_azureblob_set($res, 3, $value , $accesspolicyindex);

Default Value

''

Remarks

The expiry time of the access policy.

This property specifies the UTC expiry time of the access policy, formatted according to this page in Azure's documentation.

This property can be empty if the access policy doesn't include an expiry time.

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

This property is not available at design time.

Data Type

String

AccessPolicyId Property (CloudStorage_AzureBlob Class)

The unique Id of the access policy.

Object Oriented Interface

public function getAccessPolicyId($accesspolicyindex);
public function setAccessPolicyId($accesspolicyindex, $value);

Procedural Interface

cloudstorage_azureblob_get($res, 4 , $accesspolicyindex);
cloudstorage_azureblob_set($res, 4, $value , $accesspolicyindex);

Default Value

''

Remarks

The unique Id of the access policy.

This property specifies the unique Id of the access policy, which may be up to 64 characters in length.

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

This property is not available at design time.

Data Type

String

AccessPolicyPermissions Property (CloudStorage_AzureBlob Class)

The permissions that the access policy grants.

Object Oriented Interface

public function getAccessPolicyPermissions($accesspolicyindex);
public function setAccessPolicyPermissions($accesspolicyindex, $value);

Procedural Interface

cloudstorage_azureblob_get($res, 5 , $accesspolicyindex);
cloudstorage_azureblob_set($res, 5, $value , $accesspolicyindex);

Default Value

''

Remarks

The permissions that the access policy grants.

This property specifies the permissions that the access policy grants, in the form of an abbreviated permissions list formatted according to this page in Azure's documentation.

This property can be empty if the access policy doesn't include any permissions.

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

This property is not available at design time.

Data Type

String

AccessPolicyStartTime Property (CloudStorage_AzureBlob Class)

The start time of the access policy.

Object Oriented Interface

public function getAccessPolicyStartTime($accesspolicyindex);
public function setAccessPolicyStartTime($accesspolicyindex, $value);

Procedural Interface

cloudstorage_azureblob_get($res, 6 , $accesspolicyindex);
cloudstorage_azureblob_set($res, 6, $value , $accesspolicyindex);

Default Value

''

Remarks

The start time of the access policy.

This property specifies the UTC start time of the access policy, formatted according to this page in Azure's documentation.

This property can be empty if the access policy doesn't include a start time.

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

This property is not available at design time.

Data Type

String

Account Property (CloudStorage_AzureBlob Class)

The Azure storage account name.

Object Oriented Interface

public function getAccount();
public function setAccount($value);

Procedural Interface

cloudstorage_azureblob_get($res, 7 );
cloudstorage_azureblob_set($res, 7, $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_AzureBlob Class)

OAuth 2.0 Authorization Token.

Object Oriented Interface

public function getAuthorization();
public function setAuthorization($value);

Procedural Interface

cloudstorage_azureblob_get($res, 8 );
cloudstorage_azureblob_set($res, 8, $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

Assign this value to the Authorization property before attempting any operations. Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Note: if both this property and AccessKey are populated, this property takes precedence, and the class will use OAuth authentication instead of shared key authentication. The Account property must be set in either case.

Data Type

String

BlobData Property (CloudStorage_AzureBlob Class)

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

Object Oriented Interface

public function getBlobData();
public function setBlobData($value);

Procedural Interface

cloudstorage_azureblob_get($res, 9 );
cloudstorage_azureblob_set($res, 9, $value );

Default Value

''

Remarks

This property is populated with blob data after calling GetBlob if LocalFile is not set.

This property can also be set before calling AppendBlock, CreateBlob (for block blobs), PutBlock, or PutPages; its data will be uploaded if LocalFile is not set.

This property is not available at design time.

Data Type

Binary String

BlobDelimiter Property (CloudStorage_AzureBlob Class)

The delimiter string to use when listing blobs.

Object Oriented Interface

public function getBlobDelimiter();
public function setBlobDelimiter($value);

Procedural Interface

cloudstorage_azureblob_get($res, 10 );
cloudstorage_azureblob_set($res, 10, $value );

Default Value

''

Remarks

If this property is non-empty when ListBlobs is called, any blobs whose names contain the same string between the specified Prefix and the first occurrence of the specified delimiter that follow will be rolled up into a "common prefix" element, which is returned in place of the individual blobs themselves.

The PrefixList event will fire once for each common prefix returned. If the StorePrefixList configuration setting is enabled, the class will also populate the PrefixCount and Prefix[i] configuration settings

Blob Namespace Traversal

By using the BlobDelimiter and Prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of blobs as if it were a filesystem. For example, assume that blobs with the following names exist within a container:

• MyCompany
• MyCompany/Department1
• MyCompany/Department2
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With BlobDelimiter set to /, we can set Prefix to successively "deeper" values before calling ListBlobs for the following effect:

This property is not available at design time.

Data Type

String

BlobMarker Property (CloudStorage_AzureBlob Class)

A marker indicating what page of blobs to return next.

Object Oriented Interface

public function getBlobMarker();
public function setBlobMarker($value);

Procedural Interface

cloudstorage_azureblob_get($res, 11 );
cloudstorage_azureblob_set($res, 11, $value );

Default Value

''

Remarks

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

Refer to ListBlobs for more information.

This property is not available at design time.

Data Type

String

BlobCount Property (CloudStorage_AzureBlob Class)

The number of records in the Blob arrays.

Object Oriented Interface

public function getBlobCount();
public function setBlobCount($value);

Procedural Interface

cloudstorage_azureblob_get($res, 12 );
cloudstorage_azureblob_set($res, 12, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• BlobContainer
• BlobContentDisposition
• BlobContentEncoding
• BlobContentLength
• BlobContentMD5
• BlobContentType
• BlobCreatedTime
• BlobETag
• BlobIsLeased
• BlobIsLeaseInfinite
• BlobLeaseState
• BlobModifiedTime
• BlobName
• BlobSequenceNum
• BlobSnapshot
• BlobSoftDeleted
• BlobType

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

This property is not available at design time.

Data Type

Integer

BlobContainer Property (CloudStorage_AzureBlob Class)

The container that the blob resides in.

Object Oriented Interface

public function getBlobContainer($blobindex);

Procedural Interface

cloudstorage_azureblob_get($res, 13 , $blobindex);

Default Value

''

Remarks

The container that the blob resides in.

This property reflects the name of the container that the blob resides in.

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

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

Data Type

String

BlobContentDisposition Property (CloudStorage_AzureBlob Class)

The blob's content disposition.

Object Oriented Interface

public function getBlobContentDisposition($blobindex);
public function setBlobContentDisposition($blobindex, $value);

Procedural Interface

cloudstorage_azureblob_get($res, 14 , $blobindex);
cloudstorage_azureblob_set($res, 14, $value , $blobindex);

Default Value

''

Remarks

The blob's content disposition.

This property specifies the blob's content disposition.

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

This property is not available at design time.

Data Type

String

BlobContentEncoding Property (CloudStorage_AzureBlob Class)

The blob's content encoding.

Object Oriented Interface

public function getBlobContentEncoding($blobindex);
public function setBlobContentEncoding($blobindex, $value);

Procedural Interface

cloudstorage_azureblob_get($res, 15 , $blobindex);
cloudstorage_azureblob_set($res, 15, $value , $blobindex);

Default Value

''

Remarks

The blob's content encoding.

This property specifies the blob's content encoding. Always empty for uncommitted block blobs.

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

This property is not available at design time.

Data Type

String

BlobContentLength Property (CloudStorage_AzureBlob Class)

The size of the blob.

Object Oriented Interface

public function getBlobContentLength($blobindex);

Procedural Interface

cloudstorage_azureblob_get($res, 16 , $blobindex);

Default Value

0

Remarks

The size of the blob.

For block blobs and append blobs, this property reflects the size of the blob's (committed) data, in bytes. For page blobs, this property reflects the blob's capacity in bytes.

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

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

Data Type

Long64

BlobContentMD5 Property (CloudStorage_AzureBlob Class)

An MD5 hash of the blob's content.

Object Oriented Interface

public function getBlobContentMD5($blobindex);
public function setBlobContentMD5($blobindex, $value);

Procedural Interface

cloudstorage_azureblob_get($res, 17 , $blobindex);
cloudstorage_azureblob_set($res, 17, $value , $blobindex);

Default Value

''

Remarks

An MD5 hash of the blob's content.

This property specifies an MD5 hash of the blob's content. Always empty for uncommitted block blobs.

Note that the server generally won't calculate this value automatically.

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

This property is not available at design time.

Data Type

String

BlobContentType Property (CloudStorage_AzureBlob Class)

The blob's content type.

Object Oriented Interface

public function getBlobContentType($blobindex);
public function setBlobContentType($blobindex, $value);

Procedural Interface

cloudstorage_azureblob_get($res, 18 , $blobindex);
cloudstorage_azureblob_set($res, 18, $value , $blobindex);

Default Value

''

Remarks

The blob's content type.

This property specifies the blob's content type. Always empty for uncommitted block blobs.

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

This property is not available at design time.

Data Type

String

BlobCreatedTime Property (CloudStorage_AzureBlob Class)

The creation time of the blob.

Object Oriented Interface

public function getBlobCreatedTime($blobindex);

Procedural Interface

cloudstorage_azureblob_get($res, 19 , $blobindex);

Default Value

''

Remarks

The creation time of the blob.

This property reflects the creation time of the blob, formatted according to RFC 1123.

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

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

Data Type

String

BlobETag Property (CloudStorage_AzureBlob Class)

The ETag of the blob.

Object Oriented Interface

public function getBlobETag($blobindex);

Procedural Interface

cloudstorage_azureblob_get($res, 20 , $blobindex);

Default Value

''

Remarks

The ETag of the blob.

This property reflects the ETag of the blob. Always empty for uncommitted block blobs.

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

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

Data Type

String

BlobIsLeased Property (CloudStorage_AzureBlob Class)

Whether the blob is current leased.

Object Oriented Interface

public function getBlobIsLeased($blobindex);

Procedural Interface

cloudstorage_azureblob_get($res, 21 , $blobindex);

Default Value

false

Remarks

Whether the blob is current leased.

This property indicates whether the blob is currently leased.

This property is always false if BlobSoftDeleted is true and/or BlobSnapshot is non-empty.

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

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

Data Type

Boolean

BlobIsLeaseInfinite Property (CloudStorage_AzureBlob Class)

Whether the blob's lease duration is infinite.

Object Oriented Interface

public function getBlobIsLeaseInfinite($blobindex);

Procedural Interface

cloudstorage_azureblob_get($res, 22 , $blobindex);

Default Value

false

Remarks

Whether the blob's lease duration is infinite.

This property indicates whether the blob's lease duration is fixed (false) or infinite (true).

This property is always false when BlobIsLeased is false.

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

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

Data Type

Boolean

BlobLeaseState Property (CloudStorage_AzureBlob Class)

The lease state of the blob.

Object Oriented Interface

public function getBlobLeaseState($blobindex);

Procedural Interface

cloudstorage_azureblob_get($res, 23 , $blobindex);

Default Value

0

Remarks

The lease state of the blob.

This property reflects the lease state of the blob. Possible values are:

This property is always ablsAvailable (0) when BlobIsLeased is false.

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

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

Data Type

Integer

BlobModifiedTime Property (CloudStorage_AzureBlob Class)

The last modified time of the blob.

Object Oriented Interface

public function getBlobModifiedTime($blobindex);

Procedural Interface

cloudstorage_azureblob_get($res, 24 , $blobindex);

Default Value

''

Remarks

The last modified time of the blob.

This property reflects the last modified time of the blob, formatted according to RFC 1123. Always empty for uncommitted block blobs.

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

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

Data Type

String

BlobName Property (CloudStorage_AzureBlob Class)

The name of the blob.

Object Oriented Interface

public function getBlobName($blobindex);
public function setBlobName($blobindex, $value);

Procedural Interface

cloudstorage_azureblob_get($res, 25 , $blobindex);
cloudstorage_azureblob_set($res, 25, $value , $blobindex);

Default Value

''

Remarks

The name of the blob.

This property specifies the name of the blob.

Note: Blobs cannot be renamed; this property is only writable so that applications can add new items to the Blobs properties for use with UpdateBlobInfo (which looks up items in said properties by blob name).

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

This property is not available at design time.

Data Type

String

BlobSequenceNum Property (CloudStorage_AzureBlob Class)

The sequence number of the page blob.

Object Oriented Interface

public function getBlobSequenceNum($blobindex);

Procedural Interface

cloudstorage_azureblob_get($res, 26 , $blobindex);

Default Value

0

Remarks

The sequence number of the page blob.

This property reflects the sequence number of the page blob; it is always -1 for block blobs and append blobs.

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

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

Data Type

Long64

BlobSnapshot Property (CloudStorage_AzureBlob Class)

The blob snapshot identifier.

Object Oriented Interface

public function getBlobSnapshot($blobindex);

Procedural Interface

cloudstorage_azureblob_get($res, 27 , $blobindex);

Default Value

''

Remarks

The blob snapshot identifier.

If the current item represents a blob snapshot, this property will be populated with the opaque DateTime value that identifies the snapshot. If the current items represents a base blob, this property will be empty.

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

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

Data Type

String

BlobSoftDeleted Property (CloudStorage_AzureBlob Class)

Whether the blob has been soft-deleted.

Object Oriented Interface

public function getBlobSoftDeleted($blobindex);

Procedural Interface

cloudstorage_azureblob_get($res, 28 , $blobindex);

Default Value

false

Remarks

Whether the blob has been soft-deleted.

This property indicates whether the blob (or snapshot, if BlobSnapshot is non-empty) has been soft-deleted.

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

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

Data Type

Boolean

BlobType Property (CloudStorage_AzureBlob Class)

The blob's type.

Object Oriented Interface

public function getBlobType($blobindex);

Procedural Interface

cloudstorage_azureblob_get($res, 29 , $blobindex);

Default Value

0

Remarks

The blob's type.

This property reflects the blob's type. Possible values are:

Refer to Azure's Understanding block blobs, append blobs, and page blobs article for more information about blob types.

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

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

Data Type

Integer

BlockCount Property (CloudStorage_AzureBlob Class)

The number of records in the Block arrays.

Object Oriented Interface

public function getBlockCount();
public function setBlockCount($value);

Procedural Interface

cloudstorage_azureblob_get($res, 30 );
cloudstorage_azureblob_set($res, 30, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• BlockId
• BlockSize
• BlockType

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

This property is not available at design time.

Data Type

Integer

BlockId Property (CloudStorage_AzureBlob Class)

The Id of the block.

Object Oriented Interface

public function getBlockId($blockindex);
public function setBlockId($blockindex, $value);

Procedural Interface

cloudstorage_azureblob_get($res, 31 , $blockindex);
cloudstorage_azureblob_set($res, 31, $value , $blockindex);

Default Value

''

Remarks

The Id of the block.

This property specifies the Id of the block.

Block Ids must be Base64-encoded when sent to the server. By default, the class will automatically Base64-encode block Ids as they are sent, and Base64-decode them as they are received. This behavior can be configured using the EncodeBlockIds configuration setting.

All block Ids must be less than or equal to 64 bytes in length before being Base64-encoded. Additionally, all blocks Ids within a single block blob must be unique, and of the exact same length after Base64-encoding.

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

This property is not available at design time.

Data Type

String

BlockSize Property (CloudStorage_AzureBlob Class)

The size of the block.

Object Oriented Interface

public function getBlockSize($blockindex);

Procedural Interface

cloudstorage_azureblob_get($res, 32 , $blockindex);

Default Value

-1

Remarks

The size of the block.

This property reflects the size of the block, in bytes.

This property is only populated by calls to ListBlocks, and will be -1 in all other cases.

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

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

Data Type

Integer

BlockType Property (CloudStorage_AzureBlob Class)

The type of block.

Object Oriented Interface

public function getBlockType($blockindex);
public function setBlockType($blockindex, $value);

Procedural Interface

cloudstorage_azureblob_get($res, 33 , $blockindex);
cloudstorage_azureblob_set($res, 33, $value , $blockindex);

Default Value

0

Remarks

The type of block.

When populated by ListBlocks, this property reflects the block's type (one of the first two values listed below). When used during a PutBlockList operation, this property specifies which block list the server should search for the block Id specified by BlockId.

Possible values are:

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

This property is not available at design time.

Data Type

Integer

Container Property (CloudStorage_AzureBlob Class)

Selects a container.

Object Oriented Interface

public function getContainer();
public function setContainer($value);

Procedural Interface

cloudstorage_azureblob_get($res, 34 );
cloudstorage_azureblob_set($res, 34, $value );

Default Value

''

Remarks

This property selects a container, by name, for the class to operate against. It must be set before attempting most operations.

Container Name Rules

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

ContainerMarker Property (CloudStorage_AzureBlob Class)

A marker indicating what page of containers to return next.

Object Oriented Interface

public function getContainerMarker();
public function setContainerMarker($value);

Procedural Interface

cloudstorage_azureblob_get($res, 35 );
cloudstorage_azureblob_set($res, 35, $value );

Default Value

''

Remarks

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

Refer to ListContainers for more information.

This property is not available at design time.

Data Type

String

ContainerCount Property (CloudStorage_AzureBlob Class)

The number of records in the Container arrays.

Object Oriented Interface

public function getContainerCount();

Procedural Interface

cloudstorage_azureblob_get($res, 36 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ContainerDeletedVersion
• ContainerETag
• ContainerHasImmutabilityPolicy
• ContainerHasLegalHold
• ContainerIsLeased
• ContainerIsLeaseInfinite
• ContainerLeaseState
• ContainerModifiedTime
• ContainerName
• ContainerPublicAccess
• ContainerSoftDeleted

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

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

Data Type

Integer

ContainerDeletedVersion Property (CloudStorage_AzureBlob Class)

The deleted version of the container.

Object Oriented Interface

public function getContainerDeletedVersion($containerindex);

Procedural Interface

cloudstorage_azureblob_get($res, 37 , $containerindex);

Default Value

''

Remarks

The deleted version of the container.

This property reflects the version of the container if it was soft-deleted; otherwise, it will be empty.

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

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

Data Type

String

ContainerETag Property (CloudStorage_AzureBlob Class)

The ETag of the container.

Object Oriented Interface

public function getContainerETag($containerindex);

Procedural Interface

cloudstorage_azureblob_get($res, 38 , $containerindex);

Default Value

''

Remarks

The ETag of the container.

This property reflects the container's ETag.

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

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

Data Type

String

ContainerHasImmutabilityPolicy Property (CloudStorage_AzureBlob Class)

Whether an immutability policy is set on the container.

Object Oriented Interface

public function getContainerHasImmutabilityPolicy($containerindex);

Procedural Interface

cloudstorage_azureblob_get($res, 39 , $containerindex);

Default Value

false

Remarks

Whether an immutability policy is set on the container.

This property indicates whether there is an immutability policy set on the container.

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

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

Data Type

Boolean

ContainerHasLegalHold Property (CloudStorage_AzureBlob Class)

Whether there are any legal holds on the container.

Object Oriented Interface

public function getContainerHasLegalHold($containerindex);

Procedural Interface

cloudstorage_azureblob_get($res, 40 , $containerindex);

Default Value

false

Remarks

Whether there are any legal holds on the container.

This property indicates whether there are any legal holds on the container.

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

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

Data Type

Boolean

ContainerIsLeased Property (CloudStorage_AzureBlob Class)

Whether the container is currently leased.

Object Oriented Interface

public function getContainerIsLeased($containerindex);

Procedural Interface

cloudstorage_azureblob_get($res, 41 , $containerindex);

Default Value

false

Remarks

Whether the container is currently leased.

This property indicates whether the container is currently leased.

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

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

Data Type

Boolean

ContainerIsLeaseInfinite Property (CloudStorage_AzureBlob Class)

Whether the container's lease duration is infinite.

Object Oriented Interface

public function getContainerIsLeaseInfinite($containerindex);

Procedural Interface

cloudstorage_azureblob_get($res, 42 , $containerindex);

Default Value

false

Remarks

Whether the container's lease duration is infinite.

This property indicates whether the container's lease duration is fixed (false) or infinite (true).

This property is always false when ContainerIsLeased is false.

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

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

Data Type

Boolean

ContainerLeaseState Property (CloudStorage_AzureBlob Class)

The lease state of the container.

Object Oriented Interface

public function getContainerLeaseState($containerindex);

Procedural Interface

cloudstorage_azureblob_get($res, 43 , $containerindex);

Default Value

0

Remarks

The lease state of the container.

This property reflects the lease state of the container. Possible values are:

This property is always aclsAvailable (0) when ContainerIsLeased is false.

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

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

Data Type

Integer

ContainerModifiedTime Property (CloudStorage_AzureBlob Class)

The last modified time of the container.

Object Oriented Interface

public function getContainerModifiedTime($containerindex);

Procedural Interface

cloudstorage_azureblob_get($res, 44 , $containerindex);

Default Value

''

Remarks

The last modified time of the container.

This property reflects the last modified time of the container, formatted according to RFC 1123.

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

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

Data Type

String

ContainerName Property (CloudStorage_AzureBlob Class)

The name of the container.

Object Oriented Interface

public function getContainerName($containerindex);

Procedural Interface

cloudstorage_azureblob_get($res, 45 , $containerindex);

Default Value

''

Remarks

The name of the container.

This property reflects the name of the container.

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

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

Data Type

String

ContainerPublicAccess Property (CloudStorage_AzureBlob Class)

The container's public access level.

Object Oriented Interface

public function getContainerPublicAccess($containerindex);

Procedural Interface

cloudstorage_azureblob_get($res, 46 , $containerindex);

Default Value

0

Remarks

The container's public access level.

This property reflects the container's public access level. Possible values are:

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

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

Data Type

Integer

ContainerSoftDeleted Property (CloudStorage_AzureBlob Class)

Whether the container has been soft-deleted.

Object Oriented Interface

public function getContainerSoftDeleted($containerindex);

Procedural Interface

cloudstorage_azureblob_get($res, 47 , $containerindex);

Default Value

false

Remarks

Whether the container has been soft-deleted.

This property indicates whether the container has been soft-deleted.

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

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

Data Type

Boolean

EncryptionAlgorithm Property (CloudStorage_AzureBlob Class)

The encryption algorithm.

Object Oriented Interface

public function getEncryptionAlgorithm();
public function setEncryptionAlgorithm($value);

Procedural Interface

cloudstorage_azureblob_get($res, 48 );
cloudstorage_azureblob_set($res, 48, $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_AzureBlob Class)

The encryption password.

Object Oriented Interface

public function getEncryptionPassword();
public function setEncryptionPassword($value);

Procedural Interface

cloudstorage_azureblob_get($res, 49 );
cloudstorage_azureblob_set($res, 49, $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_AzureBlob Class)

Whether to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

cloudstorage_azureblob_get($res, 50 );
cloudstorage_azureblob_set($res, 50, $value );

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (CloudStorage_AzureBlob Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

cloudstorage_azureblob_get($res, 51 );
cloudstorage_azureblob_set($res, 51, $value );

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (CloudStorage_AzureBlob Class)

The name or IP address of the firewall (optional).

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

cloudstorage_azureblob_get($res, 52 );
cloudstorage_azureblob_set($res, 52, $value );

Default Value

''

Remarks

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_AzureBlob Class)

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_azureblob_get($res, 53 );
cloudstorage_azureblob_set($res, 53, $value );

Default Value

''

Remarks

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_AzureBlob Class)

The Transmission Control Protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

cloudstorage_azureblob_get($res, 54 );
cloudstorage_azureblob_set($res, 54, $value );

Default Value

0

Remarks

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_AzureBlob Class)

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_azureblob_get($res, 55 );
cloudstorage_azureblob_set($res, 55, $value );

Default Value

''

Remarks

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_AzureBlob Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

cloudstorage_azureblob_get($res, 56 );

Default Value

true

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

LeaseId Property (CloudStorage_AzureBlob Class)

The lease Id to include when making requests.

Object Oriented Interface

public function getLeaseId();
public function setLeaseId($value);

Procedural Interface

cloudstorage_azureblob_get($res, 57 );
cloudstorage_azureblob_set($res, 57, $value );

Default Value

''

Remarks

This property specifies the lease Id to include when making requests. If non-empty, this property's value must be a GUID string formatted in one of the styles described by Microsoft's .NET Guid(string) constructor documentation. For example: dddddddd-dddd-dddd-dddd-dddddddddddd, where each d is a single case-insensitive hex digit.

The following table indicates whether this property should be populated when calling a method on a container or blob that has an active lease.

For methods in one of the "MUST" categories: if this property is empty, requests will fail if the container or blob has an active lease. For CreateBlob and CopyBlob, note that this property must be empty if the target blob does not yet exist.

For all methods listed above: if this property is populated, requests will fail if the container or blob doesn't have an active lease; or if it does, but the lease Id specified by this property does not match.

Finally, note that this property is used in a specific manner by the Lease method; refer to its documentation for more information.

This property is not available at design time.

Data Type

String

LocalFile Property (CloudStorage_AzureBlob Class)

The location of the local file.

Object Oriented Interface

public function getLocalFile();
public function setLocalFile($value);

Procedural Interface

cloudstorage_azureblob_get($res, 58 );
cloudstorage_azureblob_set($res, 58, $value );

Default Value

''

Remarks

This property specifies the location of a file on disk. This is used as the source file when calling AppendBlock, CreateBlob (for block blobs), PutBlock, or PutPages; and as the destination file when calling GetBlob.

Data Type

String

LocalHost Property (CloudStorage_AzureBlob Class)

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_azureblob_get($res, 59 );
cloudstorage_azureblob_set($res, 59, $value );

Default Value

''

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server 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_AzureBlob Class)

The number of records in the Metadata arrays.

Object Oriented Interface

public function getMetadataCount();
public function setMetadataCount($value);

Procedural Interface

cloudstorage_azureblob_get($res, 60 );
cloudstorage_azureblob_set($res, 60, $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_AzureBlob Class)

The name of the metadata item.

Object Oriented Interface

public function getMetadataName($metadataindex);
public function setMetadataName($metadataindex, $value);

Procedural Interface

cloudstorage_azureblob_get($res, 61 , $metadataindex);
cloudstorage_azureblob_set($res, 61, $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_AzureBlob Class)

The value of the metadata item.

Object Oriented Interface

public function getMetadataValue($metadataindex);
public function setMetadataValue($metadataindex, $value);

Procedural Interface

cloudstorage_azureblob_get($res, 62 , $metadataindex);
cloudstorage_azureblob_set($res, 62, $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_AzureBlob Class)

The access token returned by the authorization server.

Object Oriented Interface

public function getOAuthAccessToken();
public function setOAuthAccessToken($value);

Procedural Interface

cloudstorage_azureblob_get($res, 63 );
cloudstorage_azureblob_set($res, 63, $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_AzureBlob Class)

The authorization code that is exchanged for an access token.

Object Oriented Interface

public function getOAuthAuthorizationCode();
public function setOAuthAuthorizationCode($value);

Procedural Interface

cloudstorage_azureblob_get($res, 64 );
cloudstorage_azureblob_set($res, 64, $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_AzureBlob Class)

The scope request or response parameter used during authorization.

Object Oriented Interface

public function getOAuthAuthorizationScope();
public function setOAuthAuthorizationScope($value);

Procedural Interface

cloudstorage_azureblob_get($res, 65 );
cloudstorage_azureblob_set($res, 65, $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_AzureBlob Class)

The id of the client assigned when registering the application.

Object Oriented Interface

public function getOAuthClientId();
public function setOAuthClientId($value);

Procedural Interface

cloudstorage_azureblob_get($res, 66 );
cloudstorage_azureblob_set($res, 66, $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_AzureBlob Class)

The type of client that is requesting authorization.

Object Oriented Interface

public function getOAuthClientProfile();
public function setOAuthClientProfile($value);

Procedural Interface

cloudstorage_azureblob_get($res, 67 );
cloudstorage_azureblob_set($res, 67, $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_AzureBlob 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_azureblob_get($res, 68 );
cloudstorage_azureblob_set($res, 68, $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_AzureBlob 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_azureblob_get($res, 69 );
cloudstorage_azureblob_set($res, 69, $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_AzureBlob 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_azureblob_get($res, 70 );
cloudstorage_azureblob_set($res, 70, $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_AzureBlob 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_azureblob_get($res, 71 );
cloudstorage_azureblob_set($res, 71, $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_AzureBlob Class)

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

Object Oriented Interface

public function getOAuthReturnURL();
public function setOAuthReturnURL($value);

Procedural Interface

cloudstorage_azureblob_get($res, 72 );
cloudstorage_azureblob_set($res, 72, $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_AzureBlob Class)

The URL of the authorization server.

Object Oriented Interface

public function getOAuthServerAuthURL();
public function setOAuthServerAuthURL($value);

Procedural Interface

cloudstorage_azureblob_get($res, 73 );
cloudstorage_azureblob_set($res, 73, $value );

Default Value

''

Remarks

The URL of the authorization server.

This property is not available at design time.

Data Type

String

OAuthServerTokenURL Property (CloudStorage_AzureBlob 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_azureblob_get($res, 74 );
cloudstorage_azureblob_set($res, 74, $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_AzureBlob Class)

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

Object Oriented Interface

public function getOAuthWebAuthURL();

Procedural Interface

cloudstorage_azureblob_get($res, 75 );

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_AzureBlob Class)

Other headers as determined by the user (optional).

Object Oriented Interface

public function getOtherHeaders();
public function setOtherHeaders($value);

Procedural Interface

cloudstorage_azureblob_get($res, 76 );
cloudstorage_azureblob_set($res, 76, $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_AzureBlob Class)

Whether to overwrite the local file, or remote blob.

Object Oriented Interface

public function getOverwrite();
public function setOverwrite($value);

Procedural Interface

cloudstorage_azureblob_get($res, 77 );
cloudstorage_azureblob_set($res, 77, $value );

Default Value

false

Remarks

When calling DownloadFile, this property determines if LocalFile should be overwritten if it already exists.

When calling CreateBlob or CopyBlob, this property determines if the remote blob should be overwritten if it already exists.

Data Type

Boolean

PageRangeCount Property (CloudStorage_AzureBlob Class)

The number of records in the PageRange arrays.

Object Oriented Interface

public function getPageRangeCount();

Procedural Interface

cloudstorage_azureblob_get($res, 78 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• PageRangeFirst
• PageRangeLast

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

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

Data Type

Integer

PageRangeFirst Property (CloudStorage_AzureBlob Class)

The first byte of the range.

Object Oriented Interface

public function getPageRangeFirst($pagerangeindex);

Procedural Interface

cloudstorage_azureblob_get($res, 79 , $pagerangeindex);

Default Value

0

Remarks

The first byte of the range.

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

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

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

Data Type

Long64

PageRangeLast Property (CloudStorage_AzureBlob Class)

The last byte of the range.

Object Oriented Interface

public function getPageRangeLast($pagerangeindex);

Procedural Interface

cloudstorage_azureblob_get($res, 80 , $pagerangeindex);

Default Value

0

Remarks

The last byte of the range.

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

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

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

Data Type

Long64

ParsedHeaderCount Property (CloudStorage_AzureBlob Class)

The number of records in the ParsedHeader arrays.

Object Oriented Interface

public function getParsedHeaderCount();

Procedural Interface

cloudstorage_azureblob_get($res, 81 );

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_AzureBlob 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_azureblob_get($res, 82 , $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_AzureBlob Class)

This property contains the header contents.

Object Oriented Interface

public function getParsedHeaderValue($parsedheaderindex);

Procedural Interface

cloudstorage_azureblob_get($res, 83 , $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_AzureBlob Class)

A prefix used to restrict the results returned when listing blobs or containers.

Object Oriented Interface

public function getPrefix();
public function setPrefix($value);

Procedural Interface

cloudstorage_azureblob_get($res, 84 );
cloudstorage_azureblob_set($res, 84, $value );

Default Value

''

Remarks

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

Blob Namespace Traversal

By using the BlobDelimiter and Prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of blobs as if it were a filesystem. For example, assume that blobs with the following names exist within a container:

• MyCompany
• MyCompany/Department1
• MyCompany/Department2
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With BlobDelimiter set to /, we can set Prefix to successively "deeper" values before calling ListBlobs for the following effect:

This property is not available at design time.

Data Type

String

ProxyAuthScheme Property (CloudStorage_AzureBlob Class)

The type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();
public function setProxyAuthScheme($value);

Procedural Interface

cloudstorage_azureblob_get($res, 85 );
cloudstorage_azureblob_set($res, 85, $value );

Default Value

0

Remarks

The 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 class 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_AzureBlob Class)

Whether to automatically detect and use proxy system settings, if available.

Object Oriented Interface

public function getProxyAutoDetect();
public function setProxyAutoDetect($value);

Procedural Interface

cloudstorage_azureblob_get($res, 86 );
cloudstorage_azureblob_set($res, 86, $value );

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (CloudStorage_AzureBlob Class)

A password if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

cloudstorage_azureblob_get($res, 87 );
cloudstorage_azureblob_set($res, 87, $value );

Default Value

''

Remarks

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_AzureBlob Class)

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_azureblob_get($res, 88 );
cloudstorage_azureblob_set($res, 88, $value );

Default Value

80

Remarks

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_AzureBlob 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_azureblob_get($res, 89 );
cloudstorage_azureblob_set($res, 89, $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_AzureBlob Class)

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_azureblob_get($res, 90 );
cloudstorage_azureblob_set($res, 90, $value );

Default Value

0

Remarks

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_AzureBlob Class)

A username if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();
public function setProxyUser($value);

Procedural Interface

cloudstorage_azureblob_get($res, 91 );
cloudstorage_azureblob_set($res, 91, $value );

Default Value

''

Remarks

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_AzureBlob Class)

The number of records in the QueryParam arrays.

Object Oriented Interface

public function getQueryParamCount();
public function setQueryParamCount($value);

Procedural Interface

cloudstorage_azureblob_get($res, 92 );
cloudstorage_azureblob_set($res, 92, $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_AzureBlob Class)

The name of the query parameter.

Object Oriented Interface

public function getQueryParamName($queryparamindex);
public function setQueryParamName($queryparamindex, $value);

Procedural Interface

cloudstorage_azureblob_get($res, 93 , $queryparamindex);
cloudstorage_azureblob_set($res, 93, $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_AzureBlob Class)

The value of the query parameter.

Object Oriented Interface

public function getQueryParamValue($queryparamindex);
public function setQueryParamValue($queryparamindex, $value);

Procedural Interface

cloudstorage_azureblob_get($res, 94 , $queryparamindex);
cloudstorage_azureblob_set($res, 94, $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

Range Property (CloudStorage_AzureBlob Class)

The range of bytes to request.

Object Oriented Interface

public function getRange();
public function setRange($value);

Procedural Interface

cloudstorage_azureblob_get($res, 95 );
cloudstorage_azureblob_set($res, 95, $value );

Default Value

''

Remarks

This property specifies the range of bytes to request from the server. If this property is non-empty when a GetBlob or ListPageRanges request is being constructed, a header like x-ms-range: bytes=Range will be added to the request, with Range substituted with the specified value.

There are two valid formats for this property's value:

• StartByte-
• StartByte-EndByte

Note: If the StartByte property is greater than zero when GetBlob is called (i.e., when a download is being resumed), and this property is non-empty, the class will automatically advance the StartByte value in the specified range by StartByte bytes when sending the x-ms-range header to the server. This ensures that the previously-downloaded data at the start of the specified range is not downloaded again when the download is resumed.

This property is not available at design time.

Data Type

String

Snapshot Property (CloudStorage_AzureBlob Class)

The blob snapshot to make requests against.

Object Oriented Interface

public function getSnapshot();
public function setSnapshot($value);

Procedural Interface

cloudstorage_azureblob_get($res, 96 );
cloudstorage_azureblob_set($res, 96, $value );

Default Value

''

Remarks

This property can be set to the opaque DateTime value used to identify a particular blob snapshot before calling the following methods in order to make requests against the specified blob snapshot instead of the base blob:

• CopyBlob (to copy from a blob snapshot)
• DeleteBlob
• GetBlob
• GetBlobInfo
• GetLink (to build a link for a specific blob snapshot)
• ListPageRanges
• SendCustomRequest

Refer to the documentation of the methods listed above for more information.

This property is not available at design time.

Data Type

String

SSLAcceptServerCertEffectiveDate Property (CloudStorage_AzureBlob Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

cloudstorage_azureblob_get($res, 97 );

Default Value

''

Remarks

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_AzureBlob Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

cloudstorage_azureblob_get($res, 98 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (CloudStorage_AzureBlob Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

cloudstorage_azureblob_get($res, 99 );

Default Value

''

Remarks

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_AzureBlob Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

cloudstorage_azureblob_get($res, 100 );

Default Value

''

Remarks

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_AzureBlob Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

cloudstorage_azureblob_get($res, 101 );

Default Value

''

Remarks

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_AzureBlob Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

cloudstorage_azureblob_get($res, 102 );

Default Value

''

Remarks

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_AzureBlob Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

cloudstorage_azureblob_get($res, 103 );

Default Value

''

Remarks

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_AzureBlob Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

cloudstorage_azureblob_get($res, 104 );

Default Value

''

Remarks

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_AzureBlob Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

cloudstorage_azureblob_get($res, 105 );

Default Value

false

Remarks

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_AzureBlob Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

cloudstorage_azureblob_get($res, 106 );

Default Value

''

Remarks

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_AzureBlob Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

cloudstorage_azureblob_get($res, 107 );

Default Value

''

Remarks

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_AzureBlob Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

cloudstorage_azureblob_get($res, 108 );

Default Value

''

Remarks

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_AzureBlob Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

cloudstorage_azureblob_get($res, 109 );

Default Value

0

Remarks

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_AzureBlob Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

cloudstorage_azureblob_get($res, 110 );

Default Value

''

Remarks

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_AzureBlob Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

cloudstorage_azureblob_get($res, 111 );

Default Value

''

Remarks

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_AzureBlob Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

cloudstorage_azureblob_get($res, 112 );
cloudstorage_azureblob_set($res, 112, $value );

Default Value

'MY'

Remarks

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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (CloudStorage_AzureBlob 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_azureblob_get($res, 113 );
cloudstorage_azureblob_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

SSLAcceptServerCertStoreType Property (CloudStorage_AzureBlob Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

cloudstorage_azureblob_get($res, 114 );
cloudstorage_azureblob_set($res, 114, $value );

Default Value

0

Remarks

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_AzureBlob Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

cloudstorage_azureblob_get($res, 115 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (CloudStorage_AzureBlob Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

cloudstorage_azureblob_get($res, 116 );

Default Value

''

Remarks

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_AzureBlob Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

cloudstorage_azureblob_get($res, 117 );

Default Value

''

Remarks

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_AzureBlob Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

cloudstorage_azureblob_get($res, 118 );

Default Value

''

Remarks

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_AzureBlob Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

cloudstorage_azureblob_get($res, 119 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (CloudStorage_AzureBlob Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

cloudstorage_azureblob_get($res, 120 );

Default Value

0

Remarks

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_AzureBlob Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

cloudstorage_azureblob_get($res, 121 );

Default Value

''

Remarks

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_AzureBlob Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

cloudstorage_azureblob_get($res, 122 );
cloudstorage_azureblob_set($res, 122, $value );

Default Value

''

Remarks

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_AzureBlob Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

cloudstorage_azureblob_get($res, 123 );
cloudstorage_azureblob_set($res, 123, $value );

Default Value

''

Remarks

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_AzureBlob Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

cloudstorage_azureblob_get($res, 124 );

Default Value

''

Remarks

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_AzureBlob Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

cloudstorage_azureblob_get($res, 125 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (CloudStorage_AzureBlob Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

cloudstorage_azureblob_get($res, 126 );

Default Value

''

Remarks

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_AzureBlob Class)

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

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

cloudstorage_azureblob_get($res, 127 );

Default Value

''

Remarks

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_AzureBlob Class)

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

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

cloudstorage_azureblob_get($res, 128 );

Default Value

''

Remarks

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_AzureBlob Class)

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

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

cloudstorage_azureblob_get($res, 129 );

Default Value

''

Remarks

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_AzureBlob Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

cloudstorage_azureblob_get($res, 130 );

Default Value

''

Remarks

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_AzureBlob Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

cloudstorage_azureblob_get($res, 131 );

Default Value

''

Remarks

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_AzureBlob Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

cloudstorage_azureblob_get($res, 132 );

Default Value

false

Remarks

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_AzureBlob Class)

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

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

cloudstorage_azureblob_get($res, 133 );

Default Value

''

Remarks

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_AzureBlob Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

cloudstorage_azureblob_get($res, 134 );

Default Value

''

Remarks

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_AzureBlob Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

cloudstorage_azureblob_get($res, 135 );

Default Value

''

Remarks

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_AzureBlob Class)

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

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

cloudstorage_azureblob_get($res, 136 );

Default Value

0

Remarks

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_AzureBlob Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

cloudstorage_azureblob_get($res, 137 );

Default Value

''

Remarks

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_AzureBlob Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

cloudstorage_azureblob_get($res, 138 );

Default Value

''

Remarks

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_AzureBlob Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

cloudstorage_azureblob_get($res, 139 );
cloudstorage_azureblob_set($res, 139, $value );

Default Value

'MY'

Remarks

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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (CloudStorage_AzureBlob 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_azureblob_get($res, 140 );
cloudstorage_azureblob_set($res, 140, $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_AzureBlob Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

cloudstorage_azureblob_get($res, 141 );
cloudstorage_azureblob_set($res, 141, $value );

Default Value

0

Remarks

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_AzureBlob Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

cloudstorage_azureblob_get($res, 142 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (CloudStorage_AzureBlob Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

cloudstorage_azureblob_get($res, 143 );

Default Value

''

Remarks

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_AzureBlob Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

cloudstorage_azureblob_get($res, 144 );

Default Value

''

Remarks

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_AzureBlob Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

cloudstorage_azureblob_get($res, 145 );

Default Value

''

Remarks

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_AzureBlob Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

cloudstorage_azureblob_get($res, 146 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (CloudStorage_AzureBlob Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

cloudstorage_azureblob_get($res, 147 );

Default Value

0

Remarks

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_AzureBlob Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

cloudstorage_azureblob_get($res, 148 );

Default Value

''

Remarks

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_AzureBlob Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

cloudstorage_azureblob_get($res, 149 );
cloudstorage_azureblob_set($res, 149, $value );

Default Value

''

Remarks

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_AzureBlob Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

cloudstorage_azureblob_get($res, 150 );
cloudstorage_azureblob_set($res, 150, $value );

Default Value

''

Remarks

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_AzureBlob Class)

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_azureblob_get($res, 151 );
cloudstorage_azureblob_set($res, 151, $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:

Additional Notes

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

When Automatic is selected, 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_AzureBlob Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

cloudstorage_azureblob_get($res, 152 );

Default Value

''

Remarks

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_AzureBlob Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

cloudstorage_azureblob_get($res, 153 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (CloudStorage_AzureBlob Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

cloudstorage_azureblob_get($res, 154 );

Default Value

''

Remarks

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_AzureBlob Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

cloudstorage_azureblob_get($res, 155 );

Default Value

''

Remarks

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_AzureBlob Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

cloudstorage_azureblob_get($res, 156 );

Default Value

''

Remarks

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_AzureBlob Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

cloudstorage_azureblob_get($res, 157 );

Default Value

''

Remarks

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_AzureBlob Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

cloudstorage_azureblob_get($res, 158 );

Default Value

''

Remarks

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_AzureBlob Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

cloudstorage_azureblob_get($res, 159 );

Default Value

''

Remarks

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_AzureBlob Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

cloudstorage_azureblob_get($res, 160 );

Default Value

false

Remarks

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_AzureBlob Class)

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

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

cloudstorage_azureblob_get($res, 161 );

Default Value

''

Remarks

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_AzureBlob Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

cloudstorage_azureblob_get($res, 162 );

Default Value

''

Remarks

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_AzureBlob Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

cloudstorage_azureblob_get($res, 163 );

Default Value

''

Remarks

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_AzureBlob Class)

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

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

cloudstorage_azureblob_get($res, 164 );

Default Value

0

Remarks

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_AzureBlob Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

cloudstorage_azureblob_get($res, 165 );

Default Value

''

Remarks

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_AzureBlob Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

cloudstorage_azureblob_get($res, 166 );

Default Value

''

Remarks

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_AzureBlob Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

cloudstorage_azureblob_get($res, 167 );

Default Value

'MY'

Remarks

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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (CloudStorage_AzureBlob 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_azureblob_get($res, 168 );

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_AzureBlob Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

cloudstorage_azureblob_get($res, 169 );

Default Value

0

Remarks

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_AzureBlob Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

cloudstorage_azureblob_get($res, 170 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (CloudStorage_AzureBlob Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

cloudstorage_azureblob_get($res, 171 );

Default Value

''

Remarks

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_AzureBlob Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

cloudstorage_azureblob_get($res, 172 );

Default Value

''

Remarks

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_AzureBlob Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

cloudstorage_azureblob_get($res, 173 );

Default Value

''

Remarks

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_AzureBlob Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

cloudstorage_azureblob_get($res, 174 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (CloudStorage_AzureBlob Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

cloudstorage_azureblob_get($res, 175 );

Default Value

0

Remarks

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_AzureBlob Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

cloudstorage_azureblob_get($res, 176 );

Default Value

''

Remarks

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_AzureBlob Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

cloudstorage_azureblob_get($res, 177 );

Default Value

''

Remarks

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_AzureBlob Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

cloudstorage_azureblob_get($res, 178 );

Default Value

''

Remarks

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_AzureBlob Class)

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

Object Oriented Interface

public function getStartByte();
public function setStartByte($value);

Procedural Interface

cloudstorage_azureblob_get($res, 179 );
cloudstorage_azureblob_set($res, 179, $value );

Default Value

0

Remarks

This property specifies the byte offset from which to resume a block blob upload using CreateBlob, or a download of any blob type using GetBlob. Refer to those methods' documentation for more information about resuming uploads and downloads.

This property is not available at design time.

Data Type

Long64

Timeout Property (CloudStorage_AzureBlob Class)

The timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

cloudstorage_azureblob_get($res, 180 );
cloudstorage_azureblob_set($res, 180, $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_AzureBlob Class)

Whether to use SSL/TLS when connecting.

Object Oriented Interface

public function getUseSSL();
public function setUseSSL($value);

Procedural Interface

cloudstorage_azureblob_get($res, 181 );
cloudstorage_azureblob_set($res, 181, $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_AzureBlob Class)

Aborts a copy operation.

Object Oriented Interface

public function doAbortCopy($destblob, $copyid);

Procedural Interface

cloudstorage_azureblob_do_abortcopy($res, $destblob, $copyid);

Remarks

This method aborts the copy operation identified by the given CopyId for the destination blob DestBlob in the container currently selected by Container.

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

AddBlock Method (CloudStorage_AzureBlob Class)

Adds a block to the Blocks properties.

Object Oriented Interface

public function doAddBlock($id, $blocklisttype);

Procedural Interface

cloudstorage_azureblob_do_addblock($res, $id, $blocklisttype);

Remarks

This method adds a block to the Blocks properties. Id specifies the block's Id, and BlockListType specifies where the server should search for this block.

Block Ids must be Base64-encoded when sent to the server. By default, the class will automatically Base64-encode block Ids as they are sent, and Base64-decode them as they are received. This behavior can be configured using the EncodeBlockIds configuration setting.

All block Ids must be less than or equal to 64 bytes in length before being Base64-encoded. Additionally, all blocks Ids within a single block blob must be unique, and of the exact same length after Base64-encoding.

Valid values for BlockListType are:

AddMetadata Method (CloudStorage_AzureBlob Class)

Adds a metadata item to the Metadata properties.

Object Oriented Interface

public function doAddMetadata($name, $value);

Procedural Interface

cloudstorage_azureblob_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_AzureBlob Class)

Adds a query parameter to the QueryParams properties.

Object Oriented Interface

public function doAddQueryParam($name, $value);

Procedural Interface

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

AppendBlock Method (CloudStorage_AzureBlob Class)

Appends a block of data to an append blob.

Object Oriented Interface

public function doAppendBlock($appendblob);

Procedural Interface

cloudstorage_azureblob_do_appendblock($res, $appendblob);

Remarks

This method appends a block of data to the specified AppendBlob in the container currently selected by Container. The block of data is immediately available as part of the append blob, which must already exist.

Up to 100MB (104857600 bytes) of data may be appended in a single block, and up to 50000 blocks may be appended to a single append blob.

If the specified blob has an active lease, its lease Id must be specified using LeaseId, or the request will fail.

Authorize Method (CloudStorage_AzureBlob Class)

Get the authorization string required to access the protected resource.

Object Oriented Interface

public function doAuthorize();

Procedural Interface

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

CalcAuthorization Method (CloudStorage_AzureBlob Class)

Calculates the Authorization header based on provided credentials.

Object Oriented Interface

public function doCalcAuthorization();

Procedural Interface

cloudstorage_azureblob_do_calcauthorization($res);

Remarks

This method calculates the Authorization value using the values provided in AuthScheme, User and Password.

In most cases this method does not need to be called. The class will automatically calculate any required authorization values when a method is called such as Get or Post.

This method may be useful in cases where the Authorization value needs to be calculated prior to sending a request.

ClearPages Method (CloudStorage_AzureBlob Class)

Clears a range of pages in a page blob.

Object Oriented Interface

public function doClearPages($pageblob, $byteoffset, $pagecount);

Procedural Interface

cloudstorage_azureblob_do_clearpages($res, $pageblob, $byteoffset, $pagecount);

Remarks

This method clears PageCount pages, from ByteOffset onwards, for the specified PageBlob in the container currently selected by Container.

ByteOffset must be a multiple of 512; i.e. ByteOffset % 512 == 0. PageCount must be a number between 1 and the number of pages in the page blob following ByteOffset (inclusive).

If the specified blob has an active lease, its lease Id must be specified using LeaseId, or the request will fail.

Config Method (CloudStorage_AzureBlob Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

CopyBlob Method (CloudStorage_AzureBlob Class)

Copies a blob.

Object Oriented Interface

public function doCopyBlob($srcblob, $destblob, $destcontainer);

Procedural Interface

cloudstorage_azureblob_do_copyblob($res, $srcblob, $destblob, $destcontainer);

Remarks

This method copies the specified SrcBlob (in the container currently selected by Container) to the specified DestBlob in DestContainer. If this method finishes successfully, it will either return an asynchronous copy Id, or an empty string (if the copy has finished already).

If Snapshot is non-empty, the specified snapshot of SrcBlob will be used as the copy source. In this case, DestBlob may be the same blob as SrcBlob to "promote" the snapshot, copying its contents back to the base blob.

If DestContainer is empty, the current value of Container is used instead. If DestContainer in non-empty, the value will automatically be lowercased when preparing the request.

If DestBlob already exists, and is the same type of blob as SrcBlob, then it will be overwritten if Overwrite is enabled. However, any snapshots associated with the existing blob are retained.

If DestBlob already exists and has an active infinite-duration lease, its lease Id must be specified using LeaseId, or the request will fail. (If it exists and has an active fixed-duration lease, the request will always fail.)

If the SendMetadataOnCopy configuration setting is enabled when this method is called, all items in the Metadata properties will be sent in the copy request and applied to DestBlob. Otherwise, the server will copy the metadata items from SrcBlob to DestBlob.

If the request succeeds, 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 GetBlobInfo method to poll the DestBlob blob'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 blob to another location within the same container. string copyResult = azureblob.CopyBlob("important.zip", "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 GetBlobInfo(). if (!string.IsNullOrEmpty(copyResult)) { do { azureblob.GetBlobInfo("secrets.zip"); Console.WriteLine("Copy progress: " + azureblob.Config("CopyProgress")); } while (azureblob.Config("CopyStatus") == "pending"); }

CreateBlob Method (CloudStorage_AzureBlob Class)

Creates a new blob of the specified type.

Object Oriented Interface

public function doCreateBlob($blob, $blobtype, $pageblobsize);

Procedural Interface

cloudstorage_azureblob_do_createblob($res, $blob, $blobtype, $pageblobsize);

Remarks

This method creates a new blob named Blob in the container currently selected by Container. BlobType specifies what type of blob should be created; valid values are: Possible values are:

Refer to Azure's Understanding block blobs, append blobs, and page blobs article for more information about blob types.

PageBlobSize is only used when BlobType is abtPageBlob (1); it is ignored otherwise.

If the specified blob already exists, and is the same type of blob as BlobType specifies, then it will be overwritten if Overwrite is enabled. However, any snapshots associated with the existing blob are retained.

If the specified blob already exists and has an active lease, its lease Id must be specified using LeaseId, or the request will fail.

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.

Creating Block Blobs

Block blobs can be created either with or without data initially. In either case, after the block blob is created, its contents can be managed by uploading blocks with PutBlock and then committing a new block list using PutBlockList.

If upload data is present when this method is called to create a block blob, it will be uploaded in one of two ways. If the amount of data provided is less than or equal to the limit specified by the SimpleUploadLimit configuration setting (268435456 bytes (256MB), by default), it will be uploaded directly in the create blob request.

If more than SimpleUploadLimit bytes of data are provided, the class will first create the new block blob, and then upload the data by splitting it up into blocks (sized according to the FragmentSize configuration setting), uploading them individually, and then committing a new block list. To accomplish this, the class automatically makes calls to PutBlock and PutBlockList internally, tracks the blocks as they are uploaded using the Blocks properties, and tracks how much data has been uploaded using the StartByte property. The FragmentComplete event will fire after each block is uploaded.

If, during a block-based upload, any individual PutBlock request (or the PutBlockList request) fails, the upload can be resumed be calling this method again with the same parameters, so long as the Blocks and StartByte properties still hold the same information as they did when the upload was interrupted.

When a block-based upload completes successfully, StartByte is reset to 0, but the Blocks properties remains populated. This allows applications to easily inspect the Ids of the uploaded blocks, which the class generates automatically in the following GUID format: dddddddd-dddd-dddd-dddd-dddddddddddd (where each d is a single hex digit).

Creating Page Blobs

Unlike block blobs, no data can be uploaded when creating a page blob. However, the page blob's size (i.e., capacity) must be specified using PageBlobSize. A page blob's size must be a 512-byte-aligned; i.e. PageBlobSize % 512 == 0.

Once a page blob has been created, its contents can be manipulated using the PutPages and ClearPages methods.

Creating Append Blobs

Append blobs must also be created without uploading any data initially. After a page blob has been created, data can be appended to it using the AppendBlock method.

CreateContainer Method (CloudStorage_AzureBlob Class)

Creates a new container.

Object Oriented Interface

public function doCreateContainer();

Procedural Interface

cloudstorage_azureblob_do_createcontainer($res);

Remarks

This method creates a new container using the name specified by the Container property;

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.

Container Name Rules

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

CreateSnapshot Method (CloudStorage_AzureBlob Class)

Creates a new snapshot of a blob.

Object Oriented Interface

public function doCreateSnapshot($blob);

Procedural Interface

cloudstorage_azureblob_do_createsnapshot($res, $blob);

Remarks

This method creates a new snapshot of the specified Blob in the container currently selected by Container, and returns the opaque DateTime value used to identify the newly-created snapshot.

If the SendMetadataOnSnapshot configuration setting is enabled when this method is called, all items in the Metadata properties will be sent in the request and applied to newly-created snapshot. Otherwise, the server will copy the metadata items from Blob to the snapshot.

If the specified blob has an active lease, a lease Id may optionally be specified using LeaseId; the request will only succeed if the correct lease Id is specified.

DeleteBlob Method (CloudStorage_AzureBlob Class)

Deletes a blob.

Object Oriented Interface

public function doDeleteBlob($blob, $deleteaction);

Procedural Interface

cloudstorage_azureblob_do_deleteblob($res, $blob, $deleteaction);

Remarks

This method deletes the specified Blob in the container currently selected by Container. DeleteAction specifies how the delete operation should be handled; possible values are:

Alternatively, if Snapshot is non-empty, the specified snapshot of Blob is deleted, and DeleteAction is ignored.

If the current Azure Storage account, specified by Account, has a delete retention policy enabled for the Blob service, then this method will only soft-delete blobs (and snapshots). Soft-deleted blobs and snapshots can be listed by enabling the IncludeSoftDeleted configuration setting before calling ListBlobs, and can be undeleted at any point before their retention period expires by calling UndeleteBlob. This method can alternatively permanently delete blobs and snapshots by enabling the DeletePermanently configuration setting.

If the specified blob has an active lease, its lease Id must be specified using LeaseId, or the request will fail.

DeleteContainer Method (CloudStorage_AzureBlob Class)

Deletes a container.

Object Oriented Interface

public function doDeleteContainer();

Procedural Interface

cloudstorage_azureblob_do_deletecontainer($res);

Remarks

This method deletes the container currently selected by Container. Note that, according to the Azure documentation, when a container is deleted its name cannot be reused for at least 30 seconds.

If the current Azure Storage account, specified by Account, has a delete retention policy enabled for the Blob service, then this method will only soft-delete containers. Soft-deleted containers can be listed by enabling the IncludeSoftDeleted configuration setting before calling ListContainers, and can be undeleted at any point before their retention period expires by calling UndeleteContainer.

If the specified container has an active lease, its lease Id must be specified using LeaseId, or the request will fail.

GetBlob Method (CloudStorage_AzureBlob Class)

Downloads a blob.

Object Oriented Interface

public function doGetBlob($blob);

Procedural Interface

cloudstorage_azureblob_do_getblob($res, $blob);

Remarks

This methods downloads the specified Blob in the container currently selected by Container. If Snapshot is non-empty, the specified snapshot of Blob is downloaded instead. The Range property can be used to download a specific range of bytes from the blob.

If the specified blob has an active lease, a lease Id may optionally be specified using LeaseId; the request will only succeed if the correct lease Id is specified.

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

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

Download Notes

In the simplest use-case, downloading a blob looks like this: azureblob.LocalFile = "../MyData.zip"; azureblob.GetBlob(azureblob.Blobs[0].Name);

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 = "../MyData.zip"; azureblob.LocalFile = downloadFile; azureblob.GetBlob(azureblob.Blobs[0].Name); //The transfer is interrupted and GetBlob() above fails. Later, resume the download: //Get the size of the partially downloaded file azureblob.StartByte = new FileInfo(downloadFile).Length; azureblob.GetBlob(azureblob.Blobs[0].Name);

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. azureblob.LocalFile = "../MyData.zip"; azureblob.EncryptionPassword = "password"; azureblob.GetBlob(azureblob.Blobs[0].Name); //The transfer is interrupted and GetBlob() above fails. Later, resume the download: //Get the size of the partially downloaded temp file azureblob.StartByte = new FileInfo(azureblob.Config("DownloadTempFile")).Length; azureblob.GetBlob(azureblob.Blobs[0].Name);

GetBlobInfo Method (CloudStorage_AzureBlob Class)

Gets a blob's information and metadata.

Object Oriented Interface

public function doGetBlobInfo($blob);

Procedural Interface

cloudstorage_azureblob_do_getblobinfo($res, $blob);

Remarks

This method gets information and metadata for the specified Blob in the container currently selected by Container. If Snapshot is non-empty, information and metadata for the specified snapshot of Blob is retrieved instead.

Calling this method will fire the BlobList and MetadataList events, and will re-populate the Blobs and Metadata collection properties.

If the specified blob has an active lease, a lease Id may optionally be specified using LeaseId; the request will only succeed if the correct lease Id is specified.

GetContainerACL Method (CloudStorage_AzureBlob Class)

Gets the stored access policies and public access level for a container.

Object Oriented Interface

public function doGetContainerACL();

Procedural Interface

cloudstorage_azureblob_do_getcontaineracl($res);

Remarks

This method retrieves the stored access policies and the public access level for the container currently selected by Container. The stored access policies are used to populate the AccessPolicies properties, and the public access level is returned directly. Possible values are:

If the specified container has an active lease, a lease Id may optionally be specified using LeaseId; the request will only succeed if the correct lease Id is specified.

GetContainerInfo Method (CloudStorage_AzureBlob Class)

Gets a container's information and metadata.

Object Oriented Interface

public function doGetContainerInfo();

Procedural Interface

cloudstorage_azureblob_do_getcontainerinfo($res);

Remarks

This method gets information and metadata for the container currently selected by Container.

Calling this method will fire the ContainerList and MetadataList events, and will re-populate the Containers and Metadata collection properties.

If the specified container has an active lease, a lease Id may optionally be specified using LeaseId; the request will only succeed if the correct lease Id is specified.

GetLink Method (CloudStorage_AzureBlob Class)

Creates a link that provides access to a container, blob, or snapshot.

Object Oriented Interface

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

Procedural Interface

cloudstorage_azureblob_do_getlink($res, $blob, $permissions, $starttime, $expirytime);

Remarks

This method creates and returns a shared access signature (SAS), which is a link that provides access to a specific container, blob, or snapshot. 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.

GetUserDelegationKey Method (CloudStorage_AzureBlob Class)

Requests a new user delegation key.

Object Oriented Interface

public function doGetUserDelegationKey($starttime, $expirytime);

Procedural Interface

cloudstorage_azureblob_do_getuserdelegationkey($res, $starttime, $expirytime);

Remarks

This method requests a new user delegation key and populates UserDelegationKey with the returned information.

NOTE: This method is not currently implemented; it is reserved for future use.

Interrupt Method (CloudStorage_AzureBlob Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

cloudstorage_azureblob_do_interrupt($res);

Remarks

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

Lease Method (CloudStorage_AzureBlob Class)

Creates or manages a lease on a blob or container.

Object Oriented Interface

public function doLease($blob, $leaseaction, $newleaseid, $duration);

Procedural Interface

cloudstorage_azureblob_do_lease($res, $blob, $leaseaction, $newleaseid, $duration);

Remarks

This method creates or manages a lease on the container currently selected by Container (if Blob is empty), or on the specified Blob in that container.

LeaseAction specifies what action should occur. Possible values, and their effects, are:

• Acquire (0): Requests a new lease.
  • If no active lease currently exists, a new one is created and LeaseId is populated with the new lease's Id. If a non-empty value is passed for NewLeaseId, it is used; otherwise the server generates an Id.
  • If an active lease currently exists, its Id must be passed for NewLeaseId.
  • In either case, Duration is used to specify the length of time that the lease is valid for (see below).
• Renew (1): Renews the lease specified by LeaseId.
  • Leases can only be renewed while active or expired (and in the latter case, only if a different lease has not been acquired in the meantime).
  • Renewing an active lease will reset its expiration clock.
• Change (2): Changes the Id of the active lease specified by LeaseId to the one specified by NewLeaseId.
  • If this action is successful, the class will automatically set LeaseId to the value passed for NewLeaseId.
• Release (3): Releases the lease specified by LeaseId.
  • If this action is successful, the class will automatically clear LeaseId.
• Break (4): Breaks the current lease, either immediately or after a certain period of time (the "break period") according to the value passed for Duration.
  • The lease's Id is not required to break the lease.
  • If Duration is -1, fixed-length leases are broken after their remaining time elapses, and infinite-length leases are broken immediately.
  • Otherwise, Duration specified how many seconds (see below) the lease should continue before being broken. (For fixed-length leases, the lesser of this value and the lease's remaining time is used.)
  • If this action is successful, the LeaseBreakPeriod configuration setting is populated to indicate how long the lease's break period is.

If NewLeaseId is non-empty, if must be a GUID string formatted in one of the styles described by Microsoft's .NET Guid(string) constructor documentation. For example: dddddddd-dddd-dddd-dddd-dddddddddddd, where each d is a single case-insensitive hex digit.

The value passed for Duration is only used in the cases listed below; it is ignored otherwise.

• When LeaseAction is Acquire (0): Valid values for Duration are -1 (infinite), or a number of seconds between 15 and 60 (inclusive).
• When LeaseAction is Break (4): Valid values for Duration are -1 (unspecified), or a number of seconds between 0 and 60 (inclusive). 0 indicates the lease should be broken immediately, regardless of whether it is fixed- or infinite-length.

For more information about how leases work, refer to Azure's Lease Blob and Lease Container API documentation.

ListBlobs Method (CloudStorage_AzureBlob Class)

Lists the blobs in a container.

Object Oriented Interface

public function doListBlobs();

Procedural Interface

cloudstorage_azureblob_do_listblobs($res);

Remarks

This method lists the blobs in the container currently selected by Container.

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. The following properties and configuration settings can also be used to further tune the results returned; refer to their documentation for more information:

• BlobDelimiter
• IncludeSnapshots
• IncludeSoftDeleted
• IncludeUncommittedBlobs
• ListWithMetadata

Calling this method will fire the BlobList event once for each blob, and will also populate the Blobs properties. It may also fire the PrefixList and MetadataList events, and populate the PrefixCount and Prefix[i] configuration settings, depending on how the properties and configuration settings discussed above are set.

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

Blob Namespace Traversal

By using the BlobDelimiter and Prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of blobs as if it were a filesystem. For example, assume that blobs with the following names exist within a container:

• MyCompany
• MyCompany/Department1
• MyCompany/Department2
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With BlobDelimiter set to /, we can set Prefix to successively "deeper" values before calling ListBlobs for the following effect:

ListBlocks Method (CloudStorage_AzureBlob Class)

Lists the blocks associated with a block blob.

Object Oriented Interface

public function doListBlocks($blockblob, $blocklisttype);

Procedural Interface

cloudstorage_azureblob_do_listblocks($res, $blockblob, $blocklisttype);

Remarks

This method lists the blocks associated with the specified BlockBlob in the container currently selected by Container. BlockListType indicates which block list(s) the server should return results from; possible values are:

Alternatively, if Snapshot is non-empty, the committed blocks for the specified snapshot of BlockBlob are listed instead (and BlockListType is ignored).

Calling this method will fire the BlockList event once for each block, and will also repopulate the Blocks properties.

ListContainers Method (CloudStorage_AzureBlob Class)

Lists the containers in the blob storage account.

Object Oriented Interface

public function doListContainers();

Procedural Interface

cloudstorage_azureblob_do_listcontainers($res);

Remarks

This method lists the containers in the Azure blob 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. The ListWithMetadata and IncludeSoftDeleted configuration settings can also be used to further tune the results returned.

Calling this method will fire the ContainerList event once for each container, and will also populate the Containers properties. It may also fire the MetadataList event, depending on how the ListWithMetadata setting is configured.

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

ListPageRanges Method (CloudStorage_AzureBlob Class)

Lists the page ranges of a page blob.

Object Oriented Interface

public function doListPageRanges($pageblob);

Procedural Interface

cloudstorage_azureblob_do_listpageranges($res, $pageblob);

Remarks

This method lists the allocated page ranges of the specified PageBlob in the container currently selected by Container. If Snapshot is non-empty, the allocated page ranges for the specified snapshot of PageBlob are listed instead.

The Range property can be used to restrict the results to only the page ranges within the specified range.

Calling this method will repopulate the PageRanges properties. Every page in a page blob is exactly 512 bytes in length; thus, the size of every range returned by this method will always be a multiple of 512.

Normally, ranges of pages that are not currently allocated (either because no data has been written to them, or because they've been cleared with ClearPages) will not be returned by this method. However, setting the PreviousSnapshot configuration setting to a non-empty value will cause the server to return a list of all pages that differ between that snapshot and the base PageBlob (or the later snapshot of PageBlob specified by Snapshot); refer to PreviousSnapshot for more information.

If the specified blob has an active lease, a lease Id may optionally be specified using LeaseId; the request will only succeed if the correct lease Id is specified.

PutBlock Method (CloudStorage_AzureBlob Class)

Uploads a new block of data to a block blob.

Object Oriented Interface

public function doPutBlock($blockblob, $blockid);

Procedural Interface

cloudstorage_azureblob_do_putblock($res, $blockblob, $blockid);

Remarks

This method uploads a new block of data with the given BlockId to the specified BlockBlob in the container currently selected by Container. The block of data is uploaded in an uncommitted state; it will not be available as part of the block blob until it is committed in a PutBlockList operation.

The Base64-encoded Id of the block is returned (if the EncodeBlockIds configuration setting is disabled, the same value as passed for BlockId is returned; see below for more information).

If the specified BlockBlob does not yet exist, it is created in an uncommitted state. If an uncommitted block with the specified BlockId is already associated with the specified BlockBlob, it is replaced.

Block Ids must be Base64-encoded when sent to the server. By default, the class will automatically Base64-encode block Ids as they are sent, and Base64-decode them as they are received. This behavior can be configured using the EncodeBlockIds configuration setting.

All block Ids must be less than or equal to 64 bytes in length before being Base64-encoded. Additionally, all blocks Ids within a single block blob must be unique, and of the exact same length after Base64-encoding.

Up to 100MB (104857600 bytes) of data may be uploaded in a single block, and up to 100000 uncommitted blocks may be associated with a block blob at any time.

If the block is successfully uploaded, the class will automatically call AddBlock to add an item to the Blocks properties. This behavior can be changed using the AutoAddBlocks configuration setting.

If BlockBlob already exists and has an active lease, its lease Id must be specified using LeaseId, or the request will fail.

PutBlockList Method (CloudStorage_AzureBlob Class)

Commits a list of data blocks to a block blob.

Object Oriented Interface

public function doPutBlockList($blockblob, $blocklist);

Procedural Interface

cloudstorage_azureblob_do_putblocklist($res, $blockblob, $blocklist);

Remarks

This method commits the blocks of data specified by the Blocks properties to the specified BlockBlob in the container currently selected by Container. Up to 50000 blocks may be committed to a single block blob at any time.

The BlockList parameter can optionally be passed a non-empty list of blocks to commit in order to repopulate the Blocks properties before building the request. This allows applications to build an entire block list and then commit it in a single call, rather than manipulating the Blocks properties directly, or calling AddBlock.

The value supplied should contain a comma-separated list of strings like {BlockListType}:{BlockId}, where {BlockListType} is either C, U, or L to specify whether the server should search for a block with the associated Id in BlockBlob's committed block list, uncommitted block list, or both (uncommitted; then committed, if necessary). If necessary, the BlockListStringSeparator configuration setting can be used to change the separator string used when parsing the value.

If BlockList is empty, the current items in the Blocks properties will remain unchanged.

If the specified blob has an active lease, its lease Id must be specified using LeaseId, or the request will fail.

Note: By default, the class will automatically retrieve and re-submit the BlockBlob's current properties and metadata (if it exists) when this method is called, since Azure would clear them otherwise.

However, if one or more x-ms-blob-* headers are present in OtherHeaders when this method is called, the class will send them rather than re-submitting any of the retrieved blob properties. Similarly, if the SendMetadataOnPutBlockList configuration setting is enabled, the class will send the metadata items currently present in the Metadata properties instead of those retrieved from the server.

PutPages Method (CloudStorage_AzureBlob Class)

Uploads a range of pages to a page blob.

Object Oriented Interface

public function doPutPages($pageblob, $writeoffset);

Procedural Interface

cloudstorage_azureblob_do_putpages($res, $pageblob, $writeoffset);

Remarks

This method uploads a range of pages to the specified PageBlob in the container currently selected by Container, starting at the byte offset specified by WriteOffset. The uploaded data is immediately available as part of the page blob, which must already exist.

The upload data's size, in bytes, must be a multiple of 512 no larger than 4MB (4194304 bytes). The value passed for WriteOffset must also be a multiple of 512; WriteOffset % == 0.

Note that writing a page full of zeros will not actually clear said page, so it will still incur data storage charges. It is recommended that applications avoid writing pages that only contain zeros, or clear such pages using the ClearPages method.

If the specified blob has an active lease, its lease Id must be specified using LeaseId, or the request will fail.

Reset Method (CloudStorage_AzureBlob Class)

Resets the class to its initial state.

Object Oriented Interface

public function doReset();

Procedural Interface

cloudstorage_azureblob_do_reset($res);

Remarks

This method resets the class to its initial state.

SendCustomRequest Method (CloudStorage_AzureBlob Class)

Sends a custom request to the Azure Blob Storage service.

Object Oriented Interface

public function doSendCustomRequest($httpmethod, $blob, $requestbody);

Procedural Interface

cloudstorage_azureblob_do_sendcustomrequest($res, $httpmethod, $blob, $requestbody);

Remarks

This method can be used to send arbitrary requests to the Azure Blob Storage service.

Valid values for HttpMethod are:

• GET (default if empty)
• HEAD
• POST
• PUT
• DELETE

The Blob and RequestBody parameters may be empty if not needed.

Usage

When this method is called, the class does the following:

1. Builds a request URL, including query parameters, using the following:
   • UseSSL
   • Account (must be non-empty)
   • Container (if non-empty)
   • Blob (if non-empty)
   • Snapshot (if both it and Blob are non-empty)
   • QueryParams
2. Adds request headers from:
   • APIVersion
   • LeaseId (if non-empty)
   • IfMatch (if non-empty)
   • OtherHeaders
3. Authenticates the request using Authorization (if non-empty), or AccessKey (in which case the request is signed).
4. Sends the request, including RequestBody if non-empty.
5. Stores the response headers in the ParsedHeaders properties; and the response body in the specified LocalFile, or BlobData (using the same logic as GetBlob).

If the response body is XML data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.

SetContainerACL Method (CloudStorage_AzureBlob Class)

Sets the stored access policies and public access level for a container.

Object Oriented Interface

public function doSetContainerACL($publicaccess);

Procedural Interface

cloudstorage_azureblob_do_setcontaineracl($res, $publicaccess);

Remarks

This method sets the stored access policies and the public access level for the container currently specified by Container. The items in the AccessPolicies properties determine the new set of stored access policies, and PublicAccess determines the new public access level. Possible values are:

Note that it is not possible to do a partial update of stored access policies. That is, all stored access policies currently associated with the container will be replaced with the stored access policies sent in the request. To prevent data loss, applications should call GetContainerACL to retrieve the container's current stored access polices, and then add/modify/remove them as desired, before using this method.

If the specified container has an active lease, a lease Id may optionally be specified using LeaseId; the request will only succeed if the correct lease Id is specified.

UndeleteBlob Method (CloudStorage_AzureBlob Class)

Undeletes a soft-deleted blob.

Object Oriented Interface

public function doUndeleteBlob($blob);

Procedural Interface

cloudstorage_azureblob_do_undeleteblob($res, $blob);

Remarks

This method undeletes the specified soft-deleted Blob in the container currently selected by Container. If any soft-deleted snapshots are associated with the specified blob, they are also undeleted (note that this also works if the blob itself has not been soft-deleted).

Refer to DeleteBlob for more information about soft-deleting blobs.

UndeleteContainer Method (CloudStorage_AzureBlob Class)

Undeletes a soft-deleted container.

Object Oriented Interface

public function doUndeleteContainer($container, $deletedversion);

Procedural Interface

cloudstorage_azureblob_do_undeletecontainer($res, $container, $deletedversion);

Remarks

This method undeletes the specified soft-deleted Container with the supplied DeletedVersion. If any soft-deleted blobs and snapshots are associated with the specified container, they are also undeleted, but note that soft-deleted blobs can only be restored in this manner if the container itself was also deleted.

Refer to DeleteContainer for more information about soft-deleting containers.

UpdateBlobInfo Method (CloudStorage_AzureBlob Class)

Updates a blob's information.

Object Oriented Interface

public function doUpdateBlobInfo($blob);

Procedural Interface

cloudstorage_azureblob_do_updateblobinfo($res, $blob);

Remarks

This method updates the information of the specified Blob in the container currently selected by Container.

There must be an AzureBlobBlob properties whose BlobName property matches the specified Blob name (and whose BlobSnapshot property is empty) before this method is called.

When this method is called, the values of the following propertys on the aforementioned item are sent to the server (note that the last two are indexed configuration settings):

• BlobContentDisposition
• BlobContentEncoding
• BlobContentMD5
• BlobContentType
• BlobCacheControl[i]
• BlobContentLanguage[i]

Note that it is not possible to do a partial update of a blob's information. That is, all of the blob's current values for the aforementioned propertys will be replaced with the values sent in the request. To prevent data loss, applications should call GetBlobInfo to retrieve the blob's current information, and then modify it as desired, before using this method.

If the specified blob has an active lease, its lease Id must be specified using LeaseId, or the request will fail.

UpdateMetadata Method (CloudStorage_AzureBlob Class)

Sets the metadata for a blob or container.

Object Oriented Interface

public function doUpdateMetadata($blob);

Procedural Interface

cloudstorage_azureblob_do_updatemetadata($res, $blob);

Remarks

This method sets the metadata for the container currently selected by Container (if Blob is empty), or for the specified Blob in that container, to the items currently held by the Metadata properties.

Note that it is not possible to do a partial metadata update. That is, all metadata currently associated with the blob or container will be replaced with the metadata sent in the request. To prevent data loss, applications should call GetBlobInfo or GetContainerInfo to retrieve the blob or container's current metadata, and then modify it as desired, before using this method.

When setting the metadata of a container that has an active lease, a lease Id may optionally be specified using LeaseId; the request will only succeed if the correct lease Id is specified. When setting the metadata of a blob that has an active lease, its lease Id must be specified using LeaseId, or the request will fail.

UpdatePageBlob Method (CloudStorage_AzureBlob Class)

Updates a page blob's size and/or sequence number.

Object Oriented Interface

public function doUpdatePageBlob($pageblob, $newsize, $sequencenumaction, $newsequencenum);

Procedural Interface

cloudstorage_azureblob_do_updatepageblob($res, $pageblob, $newsize, $sequencenumaction, $newsequencenum);

Remarks

This method updates the size and/or sequence number of the specified PageBlob in the container currently selected by Container.

NewSize must either be -1 (to keep the page blob's current size), or a multiple of 512; i.e. NewSize % 512 == 0. If NewSize is less than the page blob's current size, all pages above the specified value are cleared.

SequenceNumAction determines how the page blob's sequence number should be changed; possible values are:

In cases where NewSequenceNum is used, it must be a value in the range 0 to 2^63 - 1, inclusive.

If the specified blob has an active lease, its lease Id must be specified using LeaseId, or the request will fail.

BlobList Event (CloudStorage_AzureBlob Class)

Fires once for each blob returned when listing blobs.

Object Oriented Interface

public function fireBlobList($param);

Procedural Interface

cloudstorage_azureblob_register_callback($res, 1, array($this, 'fireBlobList'));

Parameter List

 'name'
 'container'
 'blobtype'
 'snapshot'
 'contentlength'
 'contenttype'
 'createdtime'
 'modifiedtime'
 'etag'
 'softdeleted'
 'isleased'
 'leasestate'

Remarks

This event fires once for each blob returned when ListBlobs or GetBlobInfo is called.

Name is the name of the blob.

Container is the name of the blob's container.

BlobType is the blob's type. Possible values are:

Refer to Azure's Understanding block blobs, append blobs, and page blobs article for more information about blob types.

Snapshot is the snapshot identifier, if the current item represents a blob snapshot; empty otherwise.

ContentLength is the size of the blob's committed data in bytes, for block blobs and append blobs. For page blobs, its the capacity in bytes.

ContentType is the blob's content type. Always empty for uncommitted block blobs.

CreatedTime and ModifiedTime reflect the creation and last modified times of the blob, formatted according to RFC 1123. The latter is always empty for uncommitted block blobs.

ETag is the blob's ETag. Always empty for uncommitted block blobs.

SoftDeleted indicates whether the blob (or snapshot, if Snapshot is non-empty) has been soft-deleted.

IsLeased indicates whether the blob is currently leased. Always false if SoftDeleted is true and/or Snapshot is non-empty.

LeaseState reflects the lease state of the blob. Possible values are:

BlockList Event (CloudStorage_AzureBlob Class)

Fires once for each block returned when listing blocks.

Object Oriented Interface

public function fireBlockList($param);

Procedural Interface

cloudstorage_azureblob_register_callback($res, 2, array($this, 'fireBlockList'));

Parameter List

 'id'
 'blocktype'
 'size'

Remarks

This event fires once for each block returned when ListBlocks is called.

Id is the Id of the block.

BlockType reflects the block's type; possible values are:

• abktCommitted (0)
• abktUncommitted (1)

Size reflects the size of the block, in bytes.

ContainerList Event (CloudStorage_AzureBlob Class)

Fires once for each container returned when listing containers.

Object Oriented Interface

public function fireContainerList($param);

Procedural Interface

cloudstorage_azureblob_register_callback($res, 3, array($this, 'fireContainerList'));

Parameter List

 'name'
 'modifiedtime'
 'etag'
 'isleased'
 'leasestate'

Remarks

This event fires once for each container returned when ListContainers or GetContainerInfo is called.

Name is the name of the container.

ModifiedTime reflects the last modified time of the container, formatted according to RFC 1123.

ETag is the container's ETag.

IsLeased indicates whether the container is currently leased.

LeaseState reflects the lease state of the container. Possible values are:

EndTransfer Event (CloudStorage_AzureBlob Class)

This event fires when a document finishes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

cloudstorage_azureblob_register_callback($res, 4, 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_AzureBlob Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

cloudstorage_azureblob_register_callback($res, 5, 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_AzureBlob Class)

Fires after each block in an automatic block-based upload is complete.

Object Oriented Interface

public function fireFragmentComplete($param);

Procedural Interface

cloudstorage_azureblob_register_callback($res, 6, array($this, 'fireFragmentComplete'));

Parameter List

 'fragmentnumber'
 'fragmentcount'
 'interrupt'

Remarks

When CreateBlob is used to create a new block blob, and more than SimpleUploadLimit bytes of upload data is provided, the class will automatically split the upload data up into blocks to perform the upload. During the overall upload process, this event will fire after each block is uploaded, providing an indication of overall upload progress.

FragmentNumber is the number of the current block that has completed. This value starts at 1.

FragmentCount is the total number of blocks that will be uploaded.

Interrupt can be set to true to interrupt the upload. The upload may be resumed later.

Refer to CreateBlob for more information.

Header Event (CloudStorage_AzureBlob Class)

Fired every time a header line comes in.

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

cloudstorage_azureblob_register_callback($res, 7, 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_AzureBlob Class)

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

cloudstorage_azureblob_register_callback($res, 8, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

Remarks

This event is fired 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"

MetadataList Event (CloudStorage_AzureBlob Class)

Fires once for each metadata item returned when listing metadata.

Object Oriented Interface

public function fireMetadataList($param);

Procedural Interface

cloudstorage_azureblob_register_callback($res, 9, array($this, 'fireMetadataList'));

Parameter List

 'container'
 'blob'
 'snapshot'
 'name'
 'value'

Remarks

This event fires once for each metadata item returned when GetBlobInfo or GetContainerInfo is called. If the ListWithMetadata configuration setting is enabled, it also fires as metadata for each individual blob or container is returned when ListBlobs or ListContainers is called.

Container is the name of the container that the blob is in (if Blob is non-empty), or that the metadata item is associated with (if Blob is empty).

Blob, if non-empty, is the name of the blob that the metadata item is associated with.

Snapshot, if non-empty, is the opaque DateTime value that identifiers the blob snapshot that the metadata item is associated with.

Name is the name of the metadata item, without the x-ms-meta- prefix.

Value the metadata item's value.

PrefixList Event (CloudStorage_AzureBlob Class)

Fires once for each common prefix returned when listing blobs.

Object Oriented Interface

public function firePrefixList($param);

Procedural Interface

cloudstorage_azureblob_register_callback($res, 10, array($this, 'firePrefixList'));

Parameter List

 'prefix'

Remarks

This event fires once for each common prefix returned when ListBlobs is called when BlobDelimiter is non-empty. Refer to BlobDelimiter for more information.

Prefix is the common prefix.

Progress Event (CloudStorage_AzureBlob Class)

Fires during an upload or download to indicate transfer progress.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

cloudstorage_azureblob_register_callback($res, 11, 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.

SSLServerAuthentication Event (CloudStorage_AzureBlob Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

cloudstorage_azureblob_register_callback($res, 12, 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_AzureBlob Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

cloudstorage_azureblob_register_callback($res, 13, 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_AzureBlob Class)

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

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

cloudstorage_azureblob_register_callback($res, 14, 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_AzureBlob Class)

Fired while a document transfers (delivers document).

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

cloudstorage_azureblob_register_callback($res, 15, 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 (AzureBlob Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

AzureBlob Config Settings

OAuth Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (AzureBlob Class)

Common Errors

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors