Azure SDK

Azure platform SDK for Elixir 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.2.0 adds Entra ID / OAuth credentials, a supervised token cache, and idempotency-aware retries on top of the Blob Storage foundation. Queue, Table, Management, and BEAM integrations follow in later releases (see Roadmap below).

See CHANGELOG for breaking changes from v0.1.0 (sign_request/2 → authorize_request/2). Identity guide: guides/azure_identity.md.

Installation

def deps do
  [
    {:azure_sdk, "~> 0.2.0"}
  ]
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!")

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

AZURITE=true mix test

Architecture

AzureSDK
├── Identity Plane      (SharedKey, SAS, Entra TokenCredentials)
├── Data Plane          (Blob; Queue/Table reserved for later releases)
├── 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 Blob before expanding into more services.

v0.2.0 - Identity + Core Contracts (Current)

Intentionally breaking pre-1.0 release:

• Fallible Credential.authorize_request/2 and TokenCredential.get_token/3
• ClientSecretCredential, ManagedIdentityCredential, WorkloadIdentityCredential
• EnvironmentCredential, DefaultAzureCredential
• Supervised TokenCache with coalesce + telemetry
• Pipeline.Bearer
• Retry: jitter, Retry-After / x-ms-retry-after-ms, idempotent transport retries, 401 refresh-once
• Storage.ServiceVersion

v0.3.0 - Production Blob Storage

• Bounded-memory upload_stream via Put Block / Put Block List
• Range-based download_stream
• ETag conditions, leases, richer listing (list_page / lazy stream)
• SAS generation (including user-delegation SAS)

Later

Queue must not inherit naive retry; Table needs a distinct Shared Key format; ARM benefits from mature OAuth/paging/retry. Design notes live under 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