Azure Integrator V2 - Online Help
Azure Integrator V2
Questions / Feedback?

Blob Class

Properties   Methods   Events   Configuration Settings   Errors  

The Blob Component provides an easy to use interface to Microsoft's Azure Blob Service.

Class Name

InAzure_Blob

Procedural Interface

 inazure_blob_open();
 inazure_blob_close($res);
 inazure_blob_register_callback($res, $id, $function);
 inazure_blob_get_last_error($res);
 inazure_blob_get_last_error_code($res);
 inazure_blob_set($res, $id, $index, $value);
 inazure_blob_get($res, $id, $index);
 inazure_blob_do_addblock($res, $blocktype, $id);
 inazure_blob_do_addusermetadata($res, $name, $value);
 inazure_blob_do_config($res, $configurationstring);
 inazure_blob_do_copyblob($res, $blobname, $newcontainer, $newblobname);
 inazure_blob_do_createblob($res, $blobname);
 inazure_blob_do_createblock($res, $blobname, $blockid);
 inazure_blob_do_createcontainer($res);
 inazure_blob_do_createsnapshot($res, $blobname);
 inazure_blob_do_deleteblob($res, $blobname, $deleteblobaction);
 inazure_blob_do_deletecontainer($res);
 inazure_blob_do_doevents($res);
 inazure_blob_do_getblob($res, $blobname);
 inazure_blob_do_getblobmetadata($res, $blobname);
 inazure_blob_do_getcontaineracl($res);
 inazure_blob_do_getcontainermetadata($res);
 inazure_blob_do_getlink($res, $blobname, $expires);
 inazure_blob_do_interrupt($res);
 inazure_blob_do_leaseblob($res, $blobname, $leaseaction);
 inazure_blob_do_listblobs($res);
 inazure_blob_do_listblocks($res, $blobname, $blocklisttype);
 inazure_blob_do_listcontainers($res);
 inazure_blob_do_putblocklist($res, $blobname);
 inazure_blob_do_reset($res);
 inazure_blob_do_resetheaders($res);
 inazure_blob_do_setblobmetadata($res, $blobname);
 inazure_blob_do_setcontaineracl($res);
 inazure_blob_do_setcontainermetadata($res);

Remarks

The Blob service allows you to store text and binary data. The Blob service offers the following three resources: the storage account, containers, and blobs. Within your storage account, containers provide a way to organize sets of blobs.

The class allows you to create, manage, and delete Bock blobs. Block blobs are optimized for streaming, and provide a way to store large sets of data (such as files).

Please refer to Blob Service Concepts for details.

Before using the class sign up for the Azure Storage service and obtain the Account and AccessKey from Microsoft. Then you can start creating containers in your account using CreateContainer. The containers are place holders for your blobs allowing you to access them via URLs. You can then add blobs to any of your containers using CreateBlob.

There are other methods such as ListContainers, ListBlobs, GetBlob, DeleteBlob, DeleteContainer etc. that further enable you to manage your blobs.

Property List


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

AccessKeyThe Windows Azure access key.
AccessPolicyThe access policy assigned to a container.
AccountThe Windows Azure storage account name.
BlobDataContains the data of one blob/block.
BlobDelimiterThe delimiter to be used when listing blobs.
BlobsCountThe number of records in the Blobs arrays.
BlobsBlobTypeThe type of the blob.
BlobsCacheControlThe Blob service stores this value but does not use or modify it.
BlobsContentEncodingThe content encoding of the blob.
BlobsContentLanguageThe content language of the blob.
BlobsContentLengthThe content size in bytes of the blob.
BlobsContentMD5The Content-MD5 of the blob.
BlobsContentTypeThe MIME content type of the blob.
BlobsETagThe ETag of the blob.
BlobsLastModifiedThe date and time the blob was last modified.
BlobsLeaseStatusThe lease status of the blob.
BlobsNameThe name of the blob.
BlobsSnapshotThe DateTime value that uniquely identifies a snapshot.
BlobsURLThe URL of the blob.
BlobSnapshotThe DateTime value that uniquely identifies a snapshot.
BlocksCountThe number of records in the Blocks arrays.
BlocksTypeIndicates the type of the block.
BlocksIdThe ID of the block.
BlocksSizeThe size of the block.
ConnectedShows whether the component is connected.
ContainerNameIdentifies the container in which an operation will be performed.
ContainersCountThe number of records in the Containers arrays.
ContainersETagThe ETag of the current container.
ContainersLastModifiedThe date and time the container was last modified.
ContainersNameThe name of the current container.
ContainersURLThe URL of the current container.
EncryptionPasswordThe password to use when encrypting/decrypting a blob.
FirewallAutoDetectThis property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
FollowRedirectsDetermines what happens when the server issues a redirect.
IdleThe current status of the component.
IfMatchSpecifies the condition for which the operation should be performed.
LeaseIdThe unique Lease ID of a blob.
LocalFileThe path to a local file for uploading or downloading blob data. When downloading, if the file exists it is overwritten (optional).
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MarkerA string value that identifies the current position in the list of results.
MetadataCountThe number of records in the Metadata arrays.
MetadataNameThe name of the current metadata element.
MetadataValueThe value of the current metadata element.
OtherHeadersOther headers as determined by the user (optional).
OverwriteWhether or not the component should overwrite files during transfer.
ParsedHeaderCountThe number of records in the ParsedHeader arrays.
ParsedHeaderFieldThis property contains the name of the HTTP header (same case as it is delivered).
ParsedHeaderValueThis property contains the header contents.
PrefixFilters the results to return only blobs/containers whose names begin with the specified prefix.
ProxyAuthSchemeThis property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the TCP port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use SSL for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
RangeThe byte-range to be sent to the server.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
StatusLineThe first line of the last server response.
TimeoutA timeout for the component.
UseSSLSpecifies whether SSL will be used to access Azure Blob.

Method List


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

AddBlockAdds a block to the blocks list that will be assembled to form a blob.
AddUserMetadataAdds user specified metadata to the Metadata list.
ConfigSets or retrieves a configuration setting .
CopyBlobCopies a source blob to a destination blob within the same storage account.
CreateBlobCreates a new blob or updates the content of an existing blob within a container.
CreateBlockCreates a new block to be committed as part of a block blob.
CreateContainerCreates a new container within a storage account.
CreateSnapshotCreates a read-only snapshot of a blob.
DeleteBlobDeletes a blob.
DeleteContainerDeletes the container and any blobs that it contains.
DoEventsProcesses events from the internal message queue.
GetBlobReads or downloads a blob, including its metadata and properties.
GetBlobMetadataGets the user-specified metadata for a blob.
GetContainerACLGets the access policy for the container.
GetContainerMetadataGets the user-specified metadata for a container.
GetLinkCreates a link to access a blob for the amount of seconds specified.
InterruptInterrupt the current method.
LeaseBlobLease a blob to establish an exclusive one minute lock on a blob. LeaseAction: Acquire(0): Requests a new lease. Renew(1): Renews the lease. Release(2): Release the lease. Break(3): Break the lease, if the blob has an active lease.
ListBlobsList the blobs under a specified container.
ListBlocksList the blocks under the specified block blob.
ListContainersList the containers under the specified account.
PutBlockListCommits a blob using the specified set of block IDs that make up the blob.
ResetResets request-related properties.
ResetHeadersResets all HTTP headers, cookies, and localfile.
SetBlobMetadataSets the user-specified metadata for a blob.
SetContainerACLSets the access policy for the container.
SetContainerMetadataSets the user-specified metadata for a container.

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.

BlobListFired for every blob when ListBlobs is called.
BlockListFired for every block when ListBlocks is called.
ConnectedFired immediately after a connection completes (or fails).
ContainerListFired for every container when ListContainers is called.
DisconnectedFired when a connection is closed.
EndTransferFired when a document finishes transferring.
ErrorInformation about errors during data delivery.
HeaderFired every time a header line comes in.
MetadataFired when valid blob or container metadata is returned.
PrefixListFired for each blob prefix returned when BlobDelimiter is set and ListBlobs is called..
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferFired when a document starts transferring (after the headers).
StatusFired when the HTTP status line is received from the server.
TransferFired while a document transfers (delivers document).

Configuration Settings


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

BlobContentEncodingSpecifies which content encodings have been applied to the blob.
BlobContentTypeThe content type of the blob.
EncryptionIVThe initialization vector to be used for encryption/decryption.
EncryptionKeyThe key to use during AES encryption/decryption.
ETagThe ETag for the container/blob returned by the server.
EncodeBlockIdIf true, the id of a block will be automatically base 64 encoded and decoded.
IncludeContentMD5Specifies whether or not the Content-MD5 header will be added to the outgoing request.
IncludeMetadataDetermines if the container/blob's metadata will be returned.
IncludePropertiesSpecifies if the blob's properties should be included in the response.
IncludeSnapshotsSpecifies whether or not the blob's snapshots will be returned.
IncludeUncommittedBlobsSpecifies if uncommitted blobs will be returned.
LastModifiedThe last modified time for the container/blob returned by the server.
LinkStartTimeStartTime for Shared Access Signature (SAS) URLs.
MaxResultsSpecifies the maximum number of blobs/containers to be returned when calling ListBlobs or ListContainers.
Prefix[i]The common prefix at index 'i'.
PrefixCountThe number of common prefixes.
PrefixOtherData[i]The common prefix other data at index 'i'.
SetBlobPropertiesDetermines if to set the system properties for the blob.
SourceIfMatchSpecifies the ETag of the source blob for a conditional update.
SourceLeaseIDSpecifies the lease ID of the source blob to copy.
StartByteThe byte position of the last successfully uploaded block.
StorePrefixListIf true, store the common prefixes when ListBlobs is called.
TempPathIf set, the temporary files created during decryption will be put in the path specified.
APIVersionThe API version specified in the request.
TransferredDataReturns the entire XML response received from Azure.
URLIf set, the default URL(http://youraccount.blob.core.windows.net/) will be overridden by this value.
AzureTimeoutGets or sets the service timeout for the request in seconds.
DateFormatThe format string to be used for formatting the DateTime values received from the server.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowIdenticalRedirectURLAllow redirects to the same URL.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 2.0.6240.0