AuthAzureStorage Chilkat2 PHP Reference Documentation
AuthAzureStorage
Current Version: 11.7.0
Markdown version of this page for AI tools (v 11.7.0) · all AI docs
Chilkat.AuthAzureStorage
Hold the storage account name and Base64 account access key used to sign
Azure Storage REST requests.
Configure Azure Storage authentication using
Specify the Azure Storage service being accessed, such as
Set the
Use the configured object with
Pair this authentication object with manually constructed REST requests
when application code needs direct control over Azure Storage operations.
For an extended overview, see
AuthAzureStorage Class Overview.
Authenticate Azure Storage REST requests with account-key Shared Key signing.
Chilkat.AuthAzureStorage is a credential object for Azure
Storage Services authentication. It stores the storage account name, Base64
account access key, Azure Storage service type, authentication scheme, and
x-ms-version API version used when signing REST requests for
Blob, Queue, File, or Table storage.
Azure Storage credentials
Shared Key signing
SharedKey or
SharedKeyLite, depending on the service and request style.
Service targeting
Blob, Queue, File, or
Table.
API version header
x-ms-version value required by the Azure Storage
REST API version being used.
REST integration
Chilkat.Rest so requests are
signed automatically before being sent.
Low-level control
AuthAzureStorage object, set the storage
Account, Base64 AccessKey, Service,
Scheme, and XMsVersion, then attach it to a
Chilkat.Rest request workflow. Use
AuthAzureStorage for Shared Key authorization headers; use
Chilkat.AuthAzureSAS when the request should be authorized with
a SAS query token instead.
Object Creation
use Chilkat2\AuthAzureStorage;
try {
$authAzureStorage = new AuthAzureStorage();
// ... use $authAzureStorage ...
} catch (\Chilkat2\Exception $e) {
echo $e->getClass(), '::', $e->getMethod(), " failed\n";
echo $e->getMessage(), "\n"; // the LastErrorText of the failed call
}Creates the object. The optional array sets properties in order, as if assigned one by one (new AuthAzureStorage(['VerboseLogging' => true, 'RaiseError' => false])); an unknown or read-only name throws Error. The class is defined by the chilkat2 extension (extension=chilkat2 in php.ini): there is no PHP file to include.
There is no close(): PHP frees the object when its last reference goes (unset($authAzureStorage), $authAzureStorage = null, or the end of the function or request). Objects returned by methods are independent and freed the same way. The class may be extended (class MyAuthAzureStorage extends \Chilkat2\AuthAzureStorage); objects cannot be cloned or serialized.
When true (the default), a method that fails throws Chilkat2\Exception. When false, it returns false (or null) instead, and the reason is in LastErrorText. Objects returned by a method inherit the value of the object that returned them.
Errors
Chilkat2\Exception extends RuntimeException: getMessage() is the failed call's full LastErrorText, getClass() its class ('Chilkat2\AuthAzureStorage') and getMethod() the method name. The object remains usable. Methods that look something up and find nothing return null without throwing (each such method says so), methods that answer a question (HasMember, IsUnlocked, ...) return a plain bool, and property reads and writes do not throw for Chilkat reasons.
Misuse always throws, whatever RaiseError is: a wrong argument type is a TypeError (exact types under declare(strict_types=1)), a missing or extra argument an ArgumentCountError, a string containing a NUL byte or an out-of-range integer a ValueError, and an unknown property (properties are case-sensitive) or a write to a read-only one an Error. Named arguments work with the parameter names shown.
Strings are passed and returned as UTF-8; binary data is a PHP string of bytes. Unlocking: call (new \Chilkat2\GlobalSettings())->UnlockBundle('...') once at startup.
Properties
AccessKey
Account
The Azure storage account name. (A storage account can contain zero or more containers. A container contains properties, metadata, and zero or more blobs. A blob is any single entity comprised of binary data, properties, and metadata. )
topDebugLogFilePath
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
LastErrorHtml
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
Scheme
Can be SharedKey or SharedKeyLite. The default value is SharedKey.
Service
Can be Blob, Queue, File, or Table. The default is Blob.
Note: Authentication for the Table service did not work in versions prior to v9.5.0.83.
VerboseLogging
If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
XMsVersion
If set, automatically adds the x-ms-version HTTP request header to Azure Storage requests. The default value is 2014-02-14.