[](https://hex.pm/packages/blobex)
# Azurex
> **Note:** This package is republished on Hex as [`blobex`](https://hex.pm/packages/blobex).
> It is a maintained fork of [`azurex`](https://hex.pm/packages/azurex) with additional features
> including Req-based HTTP client and service principal authentication.
Implementation of the Azure Blob Storage [Rest API](https://docs.microsoft.com/en-us/rest/api/storageservices/blob-service-rest-api) for Elixir.
## Supported actions
Currently supports:
1. Downloading blobs
2. Uploading blobs
3. Deleting blobs
4. Stream uploading blobs
5. Listing blobs
6. Creating containers
7. Listing containers
## Installation
[Available in Hex](https://hex.pm/packages/blobex), the package can be installed
by adding `blobex` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:blobex, "~> 2.0"}
]
end
```
## Configuration
For authentication, there is support for using both an account key or service principal.
For configuration of the account key, use _either_ `storage_account_name` and `storage_account_key` _or_ `storage_account_connection_string`.
```elixir
config :blobex, Azurex.Blob.Config,
api_url: "https://sample.blob.core.windows.net", # Optional
default_container: "defaultcontainer", # Optional
storage_account_name: "sample",
storage_account_key: "access key",
storage_account_connection_string: "Storage=Account;Connection=String" # Required if storage account `name` and `key` not set
```
For configuration of service principal, use `storage_client_id`, `storage_client_secret`, `storage_tenant_id`.
```elixir
config :blobex, Azurex.Blob.Config,
api_url: "https://sample.blob.core.windows.net", # Optional
default_container: "defaultcontainer", # Optional
storage_account_name: "sample",
storage_client_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
storage_client_secret: "secret"
storage_tenant_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
```
Note that SAS token generation is currently not supported when using Service Principal.
Each of these options is then overridable per-request, if you need to work with multiple instances:
```elixir
Azurex.Blob.list_blobs(container: "other", api_uri: "https://other.blob.net")
Azurex.Blob.get_blob("file.txt", [
storage_account_connection_string: "Account=Storage;String=Connection"
])
Azurex.Blob.put_blob("file.txt", "contents", "text/plain", [
storage_account_key: "key",
storage_account_name: "name"
])
```
## Documentation
Documentation can be found at [https://hexdocs.pm/blobex](https://hexdocs.pm/blobex). Or generated using [ExDoc](https://github.com/elixir-lang/ex_doc)
## Development
The goal is to support all actions in the Azure Blob Storage [Rest API](https://docs.microsoft.com/en-us/rest/api/storageservices/blob-service-rest-api) - PRs welcome :)
