Azure SDK

Azure platform SDK for Elixir, Gleam and Erlang.

AzureSDK is not a Blob Storage library. It is a long-term, multi-service Azure SDK built on BEAM-native patterns: explicit client structs, OTP-ready design, first-class telemetry, and a reusable Req pipeline.

v0.4.1 adds public Blob properties/4 and exists?/4 (HEAD) so callers can read size and ETag without downloading, and compose ETag-guarded range reads. Queue Storage landed in v0.4.0. Table, Management, and BEAM integrations follow later (see Roadmap).

See CHANGELOG for migration notes. Identity guide: [guides/azure_identity.md](guides/azure_identity.md).

Installation

def deps do
  [
    {:azure_sdk, "~> 0.4.1"}
  ]
end

Quick start

credential =
  AzureSDK.Identity.SharedKeyCredential.new(
    "myaccount",
    System.fetch_env!("AZURE_STORAGE_KEY")
  )

client =
  AzureSDK.Storage.Client.new(
    account: "myaccount",
    credential: credential
  )

{:ok, _} = AzureSDK.Storage.Container.create(client, "uploads")
{:ok, blob} = AzureSDK.Storage.Blob.upload(client, "uploads", "hello.txt", "Hello, Azure!")

Queue Storage

queue_client =
  AzureSDK.Storage.Client.new(
    account: "myaccount",
    credential: credential,
    service: :queue
  )

{:ok, _} = AzureSDK.Storage.Queue.create(queue_client, "jobs")
{:ok, %{id: _id}} = AzureSDK.Storage.Queue.Message.put(queue_client, "jobs", "hello")
{:ok, [msg]} = AzureSDK.Storage.Queue.Message.get(queue_client, "jobs", visibility_timeout: 30)

# Still working: extend visibility without touching the body
{:ok, msg} =
  AzureSDK.Storage.Queue.Message.update(queue_client, "jobs", msg.id,
    pop_receipt: msg.pop_receipt,
    visibility_timeout: 60
  )

{:ok, :deleted} =
  AzureSDK.Storage.Queue.Message.delete(queue_client, "jobs", msg.id,
    pop_receipt: msg.pop_receipt
  )

Messages are Base64 by default (Azure Functions and v11 SDKs). For queues shared with the v12 Python or .NET SDKs, which send plain text by default, pass message_encoding: :none on both sides.

Stream upload / download

{:ok, _} =
  AzureSDK.Storage.Blob.upload_stream(client, "uploads", "large.bin", file_stream,
    block_size: 4 * 1024 * 1024
  )

{:ok, chunks} = AzureSDK.Storage.Blob.download_stream(client, "uploads", "large.bin")

Blob properties and range reads

{:ok, props} = AzureSDK.Storage.Blob.properties(client, "uploads", "large.bin")

{:ok, %{content: bytes}} =
  AzureSDK.Storage.Blob.download(
    client,
    "uploads",
    "large.bin",
    range: {0, min(1023, props.content_length - 1)},
    if_match: props.etag
  )

case AzureSDK.Storage.Blob.exists?(client, "uploads", "large.bin") do
  true -> :ok
  false -> :missing
  {:error, error} -> {:error, error}
end

Local development with Azurite

docker compose up -d

client =
  AzureSDK.Storage.Client.new(
    account: "devstoreaccount1",
    credential:
      AzureSDK.Identity.SharedKeyCredential.new(
        "devstoreaccount1",
        "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw=="
      ),
    endpoint: "http://127.0.0.1:10000/devstoreaccount1"
  )

Queue Azurite endpoint: http://127.0.0.1:10001/devstoreaccount1.

AZURITE=true mix test

Architecture

AzureSDK
├── Identity Plane      (SharedKey, SAS, Entra TokenCredentials)
├── Data Plane          (Blob, Queue; Table reserved for later)
├── Management Plane    (reserved for v0.6)
└── Platform Services   (Pipeline, Telemetry, Retry, TokenCache)

See plans/architecture.md for the full design.

Roadmap

v0.1.0 established the platform foundation. Releases after v0.2.0 deepen Storage services.

v0.4.1 - Blob properties (Current)

• Blob.properties/4 — size, ETag, content type, last-modified, metadata (HEAD)
• Blob.exists?/4 — true / false / {:error, _}
• download_stream/4 reuses properties/4 for the initial HEAD

v0.4.0 - Queue Storage

• Queue create / delete / exists / metadata / clear
• Lazy and eager listing (list_page / list_stream)
• Messages: put, get, peek, delete, update
• Put/Get/Update Message are never retried automatically; Base64 or plain-text message encoding

v0.5.0 - Table Storage

Entities, OData queries, batch, and Table Shared Key signing.

Later

ARM benefits from mature OAuth/paging/retry. Design notes live under [plans/](https://github.com/thanos/azure_sdk/tree/main/plans).

Versioning

SemVer pre-1.0.0: minor versions may include breaking changes with CHANGELOG notice.

Documentation

Telemetry

Every operation emits :telemetry events:

:telemetry.attach("ex-azure", [:azure_sdk, :request, :stop], fn _, %{duration: d}, meta, _ ->
  IO.inspect({d, meta})
end, nil)

See plans/telemetry-design.md for the full event catalog.

License

MIT