AuthAzureStorage C++ Reference Documentation

CkAuthAzureStorage

Current Version: 11.5.0
Requires Chilkat Bundle License

Chilkat.AuthAzureStorage

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

Hold the storage account name and Base64 account access key used to sign Azure Storage REST requests.

Shared Key signing

Configure Azure Storage authentication using SharedKey or SharedKeyLite, depending on the service and request style.

Service targeting

Specify the Azure Storage service being accessed, such as Blob, Queue, File, or Table.

API version header

Set the x-ms-version value required by the Azure Storage REST API version being used.

REST integration

Use the configured object with Chilkat.Rest so requests are signed automatically before being sent.

Low-level control

Pair this authentication object with manually constructed REST requests when application code needs direct control over Azure Storage operations.

Common pattern: Create an 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.

For an extended overview, see AuthAzureStorage Class Overview.

Object Creation

// Local variable on the stack
CkAuthAzureStorage obj;

// Dynamically allocate/delete
CkAuthAzureStorage *pObj = new CkAuthAzureStorage();
// ...
delete pObj;

Properties

AccessKey
void get_AccessKey(CkString &str);
const char *accessKey(void);
void put_AccessKey(const char *newVal);
Introduced in version 9.5.0.58

A valid base64 access key for the Azure storage account.

More Information and Examples
Azure Storage Blob Simple Upload
top
Account
void get_Account(CkString &str);
const char *account(void);
void put_Account(const char *newVal);
Introduced in version 9.5.0.58

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

top
DebugLogFilePath
void get_DebugLogFilePath(CkString &str);
const char *debugLogFilePath(void);
void put_DebugLogFilePath(const char *newVal);

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.

More Information and Examples
Example showing how to use DebugLogFilePath.
top
LastErrorHtml
void get_LastErrorHtml(CkString &str);
const char *lastErrorHtml(void);

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.

top
LastErrorText
void get_LastErrorText(CkString &str);
const char *lastErrorText(void);

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.

More Information and Examples
Concept of LastErrorTextLastErrorText Standard Information
top
LastErrorXml
void get_LastErrorXml(CkString &str);
const char *lastErrorXml(void);

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.

top
LastMethodSuccess
bool get_LastMethodSuccess(void);
void put_LastMethodSuccess(bool newVal);

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.

top
Scheme
void get_Scheme(CkString &str);
const char *scheme(void);
void put_Scheme(const char *newVal);
Introduced in version 9.5.0.58

Can be SharedKey or SharedKeyLite. The default value is SharedKey.

top
Service
void get_Service(CkString &str);
const char *service(void);
void put_Service(const char *newVal);
Introduced in version 9.5.0.58

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.

top
Utf8
bool get_Utf8(void);
void put_Utf8(bool newVal);

When set to true, all const char * arguments and return values are interpreted as UTF-8 strings. When set to false, they are interpreted as ANSI strings.

In Chilkat v11.0.0 and later, the default value is true. Before v11.0.0, it was false.

top
VerboseLogging
bool get_VerboseLogging(void);
void put_VerboseLogging(bool newVal);

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.

top
Version
void get_Version(CkString &str);
const char *version(void);

Version of the component/library, such as "10.1.0"

More Information and Examples
How to get the Chilkat version at runtime.
top
XMsVersion
void get_XMsVersion(CkString &str);
const char *xMsVersion(void);
void put_XMsVersion(const char *newVal);
Introduced in version 9.5.0.58

If set, automatically adds the x-ms-version HTTP request header to Azure Storage requests. The default value is 2014-02-14.

top

Methods