---
product: Chilkat
product_version: 11.7.0
language: sqlserver
language_label: SQL Server
class: AuthAzureStorage
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/sqlserver_AuthAzureStorageRef.html
---
# Chilkat AuthAzureStorage — SQL Server — v11.7.0

> Chilkat 11.7.0 · language=sqlserver · 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/sqlserver/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

**Object Creation**

```sql
DECLARE @hr int
DECLARE @authAzureStorage int
EXEC @hr = sp_OACreate 'Chilkat.AuthAzureStorage', @authAzureStorage OUT
IF @hr <> 0
BEGIN
    PRINT 'Failed to create ActiveX component'
    RETURN
END

-- ... use @authAzureStorage ...

EXEC @hr = sp_OADestroy @authAzureStorage
```

T-SQL uses the Chilkat ActiveX through the OLE Automation stored procedures. They must be enabled once on the server (`EXEC sp_configure 'Ole Automation Procedures', 1; RECONFIGURE;`), and the Chilkat ActiveX registered must match the bitness of the SQL Server instance (64-bit for a 64-bit SQL Server). To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `sp_OACreate 'Chilkat.AuthAzureStorage.11'` for Chilkat v11.\*.\*.

`sp_OACreate` returns an object token (an `int`) that is passed as the first argument of every `sp_OAMethod`, `sp_OAGetProperty` and `sp_OASetProperty` call, and released with `sp_OADestroy`. Objects returned by methods (such as an `HttpResponse` or `JsonObject`) are also tokens received through an `int` OUT parameter; they must likewise be destroyed, and the OUT parameter is `NULL` when the method fails to return an object. Objects passed as arguments are passed by their token. When an OLE Automation procedure itself fails (non-zero `@hr`), `sp_OAGetErrorInfo` describes the error.

Data types: strings are `nvarchar(4000)`; integers, booleans (1 or 0) and object tokens are `int`; dates are `datetime`. In the signatures on this page, `@success`, `@iResult`, `@sResult` and the like are the OUT variables receiving a method's return value, `@iValue` / `@sValue` receive or supply a property value, and the remaining `@` variables are the method's arguments in order.

A string returned through an OUT parameter is limited to 4000 characters. For longer values, retrieve the result as a result set into a table variable instead of an OUT parameter, for example `DECLARE @tmp TABLE (outputLine ntext)` followed by `INSERT INTO @tmp EXEC sp_OAGetProperty @authAzureStorage, 'LastErrorText'`. See [string length limitations for strings returned by sp_OAMethod calls](https://www.chilkatsoft.com/sql_server_nvarchar_max_limitation.asp).

Methods that pass or return raw byte arrays are not shown on this page, because `varbinary(max)` values cannot be exchanged through `sp_OAMethod` (see [varbinary(max) limitation](https://www.chilkatsoft.com/sql_server_varbinary_max_limitation.asp)). Use the `BinData`-based alternatives (methods ending in *Bd*) or the base64 / hex string-encoded variants instead. Binary *properties* (such as `LastBinaryResult`) can be retrieved as a result set into a table variable, as shown in their signatures. Asynchronous (*\*Async*) methods and event callbacks are not available from SQL Server.

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 SQL Server.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## 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` | `EXEC sp_OAGetProperty @authAzureStorage, 'DebugLogFilePath', @sValue OUT EXEC sp_OASetProperty @authAzureStorage, 'DebugLogFilePath', @sValue` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastBinaryResult` | `INSERT INTO @tmp EXEC sp_OAGetProperty @authAzureStorage, 'LastBinaryResult'` | read-only | This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. |
| `LastErrorHtml` | `EXEC sp_OAGetProperty @authAzureStorage, 'LastErrorHtml', @sValue OUT` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `EXEC sp_OAGetProperty @authAzureStorage, 'LastErrorText', @sValue OUT` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `EXEC sp_OAGetProperty @authAzureStorage, 'LastErrorXml', @sValue OUT` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `EXEC sp_OAGetProperty @authAzureStorage, 'LastMethodSuccess', @iValue OUT EXEC sp_OASetProperty @authAzureStorage, 'LastMethodSuccess', @iValue` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `EXEC sp_OAGetProperty @authAzureStorage, 'LastStringResult', @sValue OUT` | read-only | In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. |
| `LastStringResultLen` | `EXEC sp_OAGetProperty @authAzureStorage, 'LastStringResultLen', @iValue OUT` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `EXEC sp_OAGetProperty @authAzureStorage, 'VerboseLogging', @iValue OUT EXEC sp_OASetProperty @authAzureStorage, 'VerboseLogging', @iValue` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `EXEC sp_OAGetProperty @authAzureStorage, 'Version', @sValue OUT` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AccessKey` | property, read/write | `EXEC sp_OAGetProperty @authAzureStorage, 'AccessKey', @sValue OUT EXEC sp_OASetProperty @authAzureStorage, 'AccessKey', @sValue` |
| `Account` | property, read/write | `EXEC sp_OAGetProperty @authAzureStorage, 'Account', @sValue OUT EXEC sp_OASetProperty @authAzureStorage, 'Account', @sValue` |
| `Scheme` | property, read/write | `EXEC sp_OAGetProperty @authAzureStorage, 'Scheme', @sValue OUT EXEC sp_OASetProperty @authAzureStorage, 'Scheme', @sValue` |
| `Service` | property, read/write | `EXEC sp_OAGetProperty @authAzureStorage, 'Service', @sValue OUT EXEC sp_OASetProperty @authAzureStorage, 'Service', @sValue` |
| `XMsVersion` | property, read/write | `EXEC sp_OAGetProperty @authAzureStorage, 'XMsVersion', @sValue OUT EXEC sp_OASetProperty @authAzureStorage, 'XMsVersion', @sValue` |

## Properties

### AuthAzureStorage.AccessKey

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

```sql
EXEC sp_OAGetProperty @authAzureStorage, 'AccessKey', @sValue OUT
EXEC sp_OASetProperty @authAzureStorage, 'AccessKey', @sValue
```

A valid base64 access key for the Azure storage account.

### AuthAzureStorage.Account

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

```sql
EXEC sp_OAGetProperty @authAzureStorage, 'Account', @sValue OUT
EXEC sp_OASetProperty @authAzureStorage, 'Account', @sValue
```

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 · sqlserver · AuthAzureStorage · Scheme · property · read/write · since 9.5.0.58`

```sql
EXEC sp_OAGetProperty @authAzureStorage, 'Scheme', @sValue OUT
EXEC sp_OASetProperty @authAzureStorage, 'Scheme', @sValue
```

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

### AuthAzureStorage.Service

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

```sql
EXEC sp_OAGetProperty @authAzureStorage, 'Service', @sValue OUT
EXEC sp_OASetProperty @authAzureStorage, 'Service', @sValue
```

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 · sqlserver · AuthAzureStorage · XMsVersion · property · read/write · since 9.5.0.58`

```sql
EXEC sp_OAGetProperty @authAzureStorage, 'XMsVersion', @sValue OUT
EXEC sp_OASetProperty @authAzureStorage, 'XMsVersion', @sValue
```

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

