---
product: Chilkat
product_version: 11.7.0
language: c
language_label: C
class: AuthAzureStorage
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/c_CkAuthAzureStorageRef.html
---
# Chilkat AuthAzureStorage — C — v11.7.0

> Chilkat 11.7.0 · language=c · class=AuthAzureStorage
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/AuthAzureStorage.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/c/guide.md`.

## Purpose

**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](https://www.chilkatsoft.com/authazurestorage_class_overview.asp).

## Object creation, unlocking and error handling

**Create/Dispose**

```c
HCkAuthAzureStorage instance = CkAuthAzureStorage_Create();
// ...
CkAuthAzureStorage_Dispose(instance);
```

`HCkAuthAzureStorage CkAuthAzureStorage_Create(void);`

Creates an instance of the HCkAuthAzureStorage object and returns a handle ("void \*" pointer). The handle is passed in the 1st argument for the functions listed on this page.

`void CkAuthAzureStorage_Dispose(HCkAuthAzureStorage handle);`

Objects created by calling CkAuthAzureStorage_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkAuthAzureStorage_Dispose.

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in C.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `void CkAuthAzureStorage_getDebugLogFilePath(HCkAuthAzureStorage cHandle, HCkString retval); void CkAuthAzureStorage_putDebugLogFilePath(HCkAuthAzureStorage cHandle, const char *newVal); const char *CkAuthAzureStorage_debugLogFilePath(HCkAuthAzureStorage cHandle);` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastErrorHtml` | `void CkAuthAzureStorage_getLastErrorHtml(HCkAuthAzureStorage cHandle, HCkString retval); const char *CkAuthAzureStorage_lastErrorHtml(HCkAuthAzureStorage cHandle);` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `void CkAuthAzureStorage_getLastErrorText(HCkAuthAzureStorage cHandle, HCkString retval); const char *CkAuthAzureStorage_lastErrorText(HCkAuthAzureStorage cHandle);` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `void CkAuthAzureStorage_getLastErrorXml(HCkAuthAzureStorage cHandle, HCkString retval); const char *CkAuthAzureStorage_lastErrorXml(HCkAuthAzureStorage cHandle);` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `BOOL CkAuthAzureStorage_getLastMethodSuccess(HCkAuthAzureStorage cHandle); void CkAuthAzureStorage_putLastMethodSuccess(HCkAuthAzureStorage cHandle, BOOL newVal);` | read/write | Indicates the success or failure of the most recent method call: `TRUE` means success, `FALSE` means failure. |
| `Utf8` | `BOOL CkAuthAzureStorage_getUtf8(HCkAuthAzureStorage cHandle); void CkAuthAzureStorage_putUtf8(HCkAuthAzureStorage cHandle, BOOL newVal);` | read/write | When set to `TRUE`, all `const char *` arguments and return values are interpreted as UTF-8 strings. |
| `VerboseLogging` | `BOOL CkAuthAzureStorage_getVerboseLogging(HCkAuthAzureStorage cHandle); void CkAuthAzureStorage_putVerboseLogging(HCkAuthAzureStorage cHandle, BOOL newVal);` | read/write | If set to `TRUE`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `void CkAuthAzureStorage_getVersion(HCkAuthAzureStorage cHandle, HCkString retval); const char *CkAuthAzureStorage_version(HCkAuthAzureStorage cHandle);` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AccessKey` | property, read/write | `void CkAuthAzureStorage_getAccessKey(HCkAuthAzureStorage cHandle, HCkString retval); void CkAuthAzureStorage_putAccessKey(HCkAuthAzureStorage cHandle, const char *newVal); const char *CkAuthAzureStorage_accessKey(HCkAuthAzureStorage cHandle);` |
| `Account` | property, read/write | `void CkAuthAzureStorage_getAccount(HCkAuthAzureStorage cHandle, HCkString retval); void CkAuthAzureStorage_putAccount(HCkAuthAzureStorage cHandle, const char *newVal); const char *CkAuthAzureStorage_account(HCkAuthAzureStorage cHandle);` |
| `Scheme` | property, read/write | `void CkAuthAzureStorage_getScheme(HCkAuthAzureStorage cHandle, HCkString retval); void CkAuthAzureStorage_putScheme(HCkAuthAzureStorage cHandle, const char *newVal); const char *CkAuthAzureStorage_scheme(HCkAuthAzureStorage cHandle);` |
| `Service` | property, read/write | `void CkAuthAzureStorage_getService(HCkAuthAzureStorage cHandle, HCkString retval); void CkAuthAzureStorage_putService(HCkAuthAzureStorage cHandle, const char *newVal); const char *CkAuthAzureStorage_service(HCkAuthAzureStorage cHandle);` |
| `XMsVersion` | property, read/write | `void CkAuthAzureStorage_getXMsVersion(HCkAuthAzureStorage cHandle, HCkString retval); void CkAuthAzureStorage_putXMsVersion(HCkAuthAzureStorage cHandle, const char *newVal); const char *CkAuthAzureStorage_xMsVersion(HCkAuthAzureStorage cHandle);` |

## Properties

### AuthAzureStorage.AccessKey

`Chilkat 11.7.0 · c · AuthAzureStorage · AccessKey · property · read/write · since 9.5.0.58`

```c
void CkAuthAzureStorage_getAccessKey(HCkAuthAzureStorage cHandle, HCkString retval);
void CkAuthAzureStorage_putAccessKey(HCkAuthAzureStorage cHandle, const char *newVal);
const char *CkAuthAzureStorage_accessKey(HCkAuthAzureStorage cHandle);
```

A valid base64 access key for the Azure storage account.

### AuthAzureStorage.Account

`Chilkat 11.7.0 · c · AuthAzureStorage · Account · property · read/write · since 9.5.0.58`

```c
void CkAuthAzureStorage_getAccount(HCkAuthAzureStorage cHandle, HCkString retval);
void CkAuthAzureStorage_putAccount(HCkAuthAzureStorage cHandle, const char *newVal);
const char *CkAuthAzureStorage_account(HCkAuthAzureStorage cHandle);
```

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

### AuthAzureStorage.Scheme

`Chilkat 11.7.0 · c · AuthAzureStorage · Scheme · property · read/write · since 9.5.0.58`

```c
void CkAuthAzureStorage_getScheme(HCkAuthAzureStorage cHandle, HCkString retval);
void CkAuthAzureStorage_putScheme(HCkAuthAzureStorage cHandle, const char *newVal);
const char *CkAuthAzureStorage_scheme(HCkAuthAzureStorage cHandle);
```

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

### AuthAzureStorage.Service

`Chilkat 11.7.0 · c · AuthAzureStorage · Service · property · read/write · since 9.5.0.58`

```c
void CkAuthAzureStorage_getService(HCkAuthAzureStorage cHandle, HCkString retval);
void CkAuthAzureStorage_putService(HCkAuthAzureStorage cHandle, const char *newVal);
const char *CkAuthAzureStorage_service(HCkAuthAzureStorage cHandle);
```

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.

### AuthAzureStorage.XMsVersion

`Chilkat 11.7.0 · c · AuthAzureStorage · XMsVersion · property · read/write · since 9.5.0.58`

```c
void CkAuthAzureStorage_getXMsVersion(HCkAuthAzureStorage cHandle, HCkString retval);
void CkAuthAzureStorage_putXMsVersion(HCkAuthAzureStorage cHandle, const char *newVal);
const char *CkAuthAzureStorage_xMsVersion(HCkAuthAzureStorage cHandle);
```

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