Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for Azure Blob Storage destination #430

Merged
merged 1 commit into from
Aug 5, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 83 additions & 0 deletions docs/data-routing/4-destinations/13-azure-blob-storage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
title: azure-blob-storage
---

| | |
|---|:---:|
|__Latest Version__| `v1.0.0` |
|__Input Content Type__| Any |

:::usage
Sending data to Azure Blob Storage incurs usage costs after exceeding the free
tier. See [Golioth pricing](https://golioth.io/pricing) for more information.
:::

The `azure-blob-storage` destination sends data to an [Azure Blob
Storage](https://azure.microsoft.com/en-us/products/storage/blobs) container.

### Parameters

|Parameter|Type|Description|Required|
|---|---|---|:---:|
|`conn_str`|`string`| The connection string for an Azure Blob Storage storage
account. |✅|
|`container`|`string`| The container name. |✅|

### Example Secrets

`AZURE_BLOB_CONN_STR`
```
BlobEndpoint=https://<StorageAccount>.blob.core.windows.net;SharedAccessSignature=<SharedAccessSignature>
```

### Example Usage

```yaml
destination:
type: azure-blob-storage
version: v1
parameters:
conn_str: $AZURE_BLOB_CONN_STR
container: mycontainer
```

### Example Input

> Binary data displayed as hex encoded for documentation purposes only.

```
00000000: 5249 4646 ffff ffff 5741 5645 666d 7420 RIFF....WAVEfmt
00000010: 1000 0000 0100 0100 c05d 0000 80bb 0000 .........]......
00000020: 0200 1000 6461 7461 ffff ffff eaff edff ....data........
00000030: f0ff f5ff f9ff feff 0100 0300 0800 0b00 ................
00000040: 0b00 0c00 0a00 0800 0500 0100 fbff f8ff ................
```

### Example Output

Input data is uploaded to the Azure Blob Storage container as a
[blob](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction#blobs)
with content unmodified.

> Binary data displayed as hex encoded for documentation purposes only.

```
00000000: 5249 4646 ffff ffff 5741 5645 666d 7420 RIFF....WAVEfmt
00000010: 1000 0000 0100 0100 c05d 0000 80bb 0000 .........]......
00000020: 0200 1000 6461 7461 ffff ffff eaff edff ....data........
00000030: f0ff f5ff f9ff feff 0100 0300 0800 0b00 ................
00000040: 0b00 0c00 0a00 0800 0500 0100 fbff f8ff ................
```

Blobs are created with name matching the event ID in a directory with
name matching the device ID. An example directory structure is shown below.

```
/
├─ 664b9e889a9590ccfcf822b3/
│ ├─ 28ebd981-80ae-467f-b700-ba00e7c1e3ee
│ ├─ e47e5b46-d4e3-4bf1-a413-9fc71ec9f6b0
│ ├─ ...
├─ 66632a45658c93af0895a70e/
├─ .../
```
Loading