AuthAzureStorage Tcl Reference Documentation

AuthAzureStorage

Current Version: 10.1.2

Provides functionality for authenticating calls to Azure Storage Services.

Object Creation

set myAuthAzureStorage [new CkAuthAzureStorage]

Properties

AccessKey
string
# ckStr is a CkString
CkAuthAzureStorage_get_AccessKey $myAuthAzureStorage $ckStr
set strVal [CkAuthAzureStorage_get_accessKey $myAuthAzureStorage]
CkAuthAzureStorage_put_AccessKey $myAuthAzureStorage $strVal
Introduced in version 9.5.0.58

A valid base64 access key for the Azure storage account.

More Information and Examples
top
Account
string
# ckStr is a CkString
CkAuthAzureStorage_get_Account $myAuthAzureStorage $ckStr
set strVal [CkAuthAzureStorage_get_account $myAuthAzureStorage]
CkAuthAzureStorage_put_Account $myAuthAzureStorage $strVal
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
string
# ckStr is a CkString
CkAuthAzureStorage_get_DebugLogFilePath $myAuthAzureStorage $ckStr
set strVal [CkAuthAzureStorage_get_debugLogFilePath $myAuthAzureStorage]
CkAuthAzureStorage_put_DebugLogFilePath $myAuthAzureStorage $strVal

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
top
LastErrorHtml
string
# ckStr is a CkString
CkAuthAzureStorage_get_LastErrorHtml $myAuthAzureStorage $ckStr
set strVal [CkAuthAzureStorage_get_lastErrorHtml $myAuthAzureStorage]

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
string
# ckStr is a CkString
CkAuthAzureStorage_get_LastErrorText $myAuthAzureStorage $ckStr
set strVal [CkAuthAzureStorage_get_lastErrorText $myAuthAzureStorage]

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.

top
LastErrorXml
string
# ckStr is a CkString
CkAuthAzureStorage_get_LastErrorXml $myAuthAzureStorage $ckStr
set strVal [CkAuthAzureStorage_get_lastErrorXml $myAuthAzureStorage]

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
boolean 1/0
set boolVal [CkAuthAzureStorage_get_LastMethodSuccess $myAuthAzureStorage]
CkAuthAzureStorage_put_LastMethodSuccess $myAuthAzureStorage $boolVal

Indicates the success or failure of the most recent method call: 1 means success, 0 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.

top
Scheme
string
# ckStr is a CkString
CkAuthAzureStorage_get_Scheme $myAuthAzureStorage $ckStr
set strVal [CkAuthAzureStorage_get_scheme $myAuthAzureStorage]
CkAuthAzureStorage_put_Scheme $myAuthAzureStorage $strVal
Introduced in version 9.5.0.58

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

top
Service
string
# ckStr is a CkString
CkAuthAzureStorage_get_Service $myAuthAzureStorage $ckStr
set strVal [CkAuthAzureStorage_get_service $myAuthAzureStorage]
CkAuthAzureStorage_put_Service $myAuthAzureStorage $strVal
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
boolean 1/0
set boolVal [CkAuthAzureStorage_get_Utf8 $myAuthAzureStorage]
CkAuthAzureStorage_put_Utf8 $myAuthAzureStorage $boolVal

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

top
VerboseLogging
boolean 1/0
set boolVal [CkAuthAzureStorage_get_VerboseLogging $myAuthAzureStorage]
CkAuthAzureStorage_put_VerboseLogging $myAuthAzureStorage $boolVal

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
string
# ckStr is a CkString
CkAuthAzureStorage_get_Version $myAuthAzureStorage $ckStr
set strVal [CkAuthAzureStorage_get_version $myAuthAzureStorage]

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

More Information and Examples
top
XMsVersion
string
# ckStr is a CkString
CkAuthAzureStorage_get_XMsVersion $myAuthAzureStorage $ckStr
set strVal [CkAuthAzureStorage_get_xMsVersion $myAuthAzureStorage]
CkAuthAzureStorage_put_XMsVersion $myAuthAzureStorage $strVal
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