AuthAzureStorage Zig Reference Documentation

AuthAzureStorage

Current Version: 11.6.1
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

// Add the package once:
//     zig fetch --save https://chilkatdownload.com/11.6.1/chilkat-zig-11.6.1.tar.gz
// and in build.zig:
//     const chilkat = b.dependency("chilkat", .{ .target = target, .optimize = optimize });
//     exe.root_module.addImport("chilkat", chilkat.module("chilkat"));
const chilkat = @import("chilkat");

// Once per process, before any other Chilkat call:
try chilkat.unlockBundle("Anything for 30-day trial");

const auth_azure_storage = try chilkat.AuthAzureStorage.init();
defer auth_azure_storage.deinit();
pub fn init() Allocator.Error!AuthAzureStorage

Creates the underlying native Chilkat object. AuthAzureStorage is a one-pointer struct passed by value; copying it copies the handle (two names for one object). Returns error.OutOfMemory if the library could not allocate the object. Use an object from one thread at a time; it may be handed from one thread to another.

pub fn deinit(self: AuthAzureStorage) void

Releases the native object. Call it exactly once per object (usually with defer); the handle is invalid afterwards. Objects returned by methods are owned by the caller too and are released the same way.

pub fn fromHandle(h: *chilkat.c.CkAuthAzureStorage.HCkAuthAzureStorage) AuthAzureStorage

Wraps a handle obtained from the C API (chilkat.c.CkAuthAzureStorage), taking ownership of it. The struct's handle field goes the other way, for anything the Zig API does not cover.

Errors and memory

Methods that can fail return an error union: a method whose only outcome is success or failure returns Error!void; a method producing a string returns (Error || Allocator.Error)![:0]u8; a method producing an object returns Error!T. chilkat.Error is error{ChilkatFailed}; the reason for a failure is in getLastErrorText, and the object remains usable. Properties never fail, and methods that answer a question (hasMember, isUnlocked, ...) return a plain bool.

String arguments are [:0]const u8 (UTF-8; string literals can be passed as is). String results are copies allocated with the allocator argument and owned by the caller, so they stay valid across later calls on the same object.

const text = auth_azure_storage.someMethod(allocator, ...) catch |err| {
    const why = try auth_azure_storage.getLastErrorText(allocator);
    defer allocator.free(why);
    std.debug.print("{s}\n", .{why});
    return err;
};
defer allocator.free(text);

Properties

AccessKey
// read/write
pub fn getAccessKey(self: AuthAzureStorage, allocator: Allocator) Allocator.Error![:0]u8
pub fn setAccessKey(self: AuthAzureStorage, value: [:0]const u8) void
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
// read/write
pub fn getAccount(self: AuthAzureStorage, allocator: Allocator) Allocator.Error![:0]u8
pub fn setAccount(self: AuthAzureStorage, value: [:0]const u8) void
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
// read/write
pub fn getDebugLogFilePath(self: AuthAzureStorage, allocator: Allocator) Allocator.Error![:0]u8
pub fn setDebugLogFilePath(self: AuthAzureStorage, value: [:0]const u8) void

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
// read-only
pub fn getLastErrorHtml(self: AuthAzureStorage, allocator: Allocator) Allocator.Error![:0]u8

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
// read-only
pub fn getLastErrorText(self: AuthAzureStorage, allocator: Allocator) Allocator.Error![:0]u8

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
// read-only
pub fn getLastErrorXml(self: AuthAzureStorage, allocator: Allocator) Allocator.Error![:0]u8

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
// read/write
pub fn getLastMethodSuccess(self: AuthAzureStorage) bool
pub fn setLastMethodSuccess(self: AuthAzureStorage, value: bool) void

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
// read/write
pub fn getScheme(self: AuthAzureStorage, allocator: Allocator) Allocator.Error![:0]u8
pub fn setScheme(self: AuthAzureStorage, value: [:0]const u8) void
Introduced in version 9.5.0.58

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

top
Service
// read/write
pub fn getService(self: AuthAzureStorage, allocator: Allocator) Allocator.Error![:0]u8
pub fn setService(self: AuthAzureStorage, value: [:0]const u8) void
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
VerboseLogging
// read/write
pub fn getVerboseLogging(self: AuthAzureStorage) bool
pub fn setVerboseLogging(self: AuthAzureStorage, value: bool) void

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
// read-only
pub fn getVersion(self: AuthAzureStorage, allocator: Allocator) Allocator.Error![:0]u8

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

More Information and Examples
How to get the Chilkat version at runtime.
top
XMsVersion
// read/write
pub fn getXMsVersion(self: AuthAzureStorage, allocator: Allocator) Allocator.Error![:0]u8
pub fn setXMsVersion(self: AuthAzureStorage, value: [:0]const u8) void
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