Skip to content

Commit 6f560de

Browse files
authored
Merge pull request #430 from golioth/destination/azure-blob-storage
Add documentation for Azure Blob Storage destination
2 parents ea8ba62 + 5808714 commit 6f560de

File tree

1 file changed

+83
-0
lines changed

1 file changed

+83
-0
lines changed
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
title: azure-blob-storage
3+
---
4+
5+
| | |
6+
|---|:---:|
7+
|__Latest Version__| `v1.0.0` |
8+
|__Input Content Type__| Any |
9+
10+
:::usage
11+
Sending data to Azure Blob Storage incurs usage costs after exceeding the free
12+
tier. See [Golioth pricing](https://golioth.io/pricing) for more information.
13+
:::
14+
15+
The `azure-blob-storage` destination sends data to an [Azure Blob
16+
Storage](https://azure.microsoft.com/en-us/products/storage/blobs) container.
17+
18+
### Parameters
19+
20+
|Parameter|Type|Description|Required|
21+
|---|---|---|:---:|
22+
|`conn_str`|`string`| The connection string for an Azure Blob Storage storage
23+
account. |✅|
24+
|`container`|`string`| The container name. ||
25+
26+
### Example Secrets
27+
28+
`AZURE_BLOB_CONN_STR`
29+
```
30+
BlobEndpoint=https://<StorageAccount>.blob.core.windows.net;SharedAccessSignature=<SharedAccessSignature>
31+
```
32+
33+
### Example Usage
34+
35+
```yaml
36+
destination:
37+
type: azure-blob-storage
38+
version: v1
39+
parameters:
40+
conn_str: $AZURE_BLOB_CONN_STR
41+
container: mycontainer
42+
```
43+
44+
### Example Input
45+
46+
> Binary data displayed as hex encoded for documentation purposes only.
47+
48+
```
49+
00000000: 5249 4646 ffff ffff 5741 5645 666d 7420 RIFF....WAVEfmt
50+
00000010: 1000 0000 0100 0100 c05d 0000 80bb 0000 .........]......
51+
00000020: 0200 1000 6461 7461 ffff ffff eaff edff ....data........
52+
00000030: f0ff f5ff f9ff feff 0100 0300 0800 0b00 ................
53+
00000040: 0b00 0c00 0a00 0800 0500 0100 fbff f8ff ................
54+
```
55+
56+
### Example Output
57+
58+
Input data is uploaded to the Azure Blob Storage container as a
59+
[blob](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction#blobs)
60+
with content unmodified.
61+
62+
> Binary data displayed as hex encoded for documentation purposes only.
63+
64+
```
65+
00000000: 5249 4646 ffff ffff 5741 5645 666d 7420 RIFF....WAVEfmt
66+
00000010: 1000 0000 0100 0100 c05d 0000 80bb 0000 .........]......
67+
00000020: 0200 1000 6461 7461 ffff ffff eaff edff ....data........
68+
00000030: f0ff f5ff f9ff feff 0100 0300 0800 0b00 ................
69+
00000040: 0b00 0c00 0a00 0800 0500 0100 fbff f8ff ................
70+
```
71+
72+
Blobs are created with name matching the event ID in a directory with
73+
name matching the device ID. An example directory structure is shown below.
74+
75+
```
76+
/
77+
├─ 664b9e889a9590ccfcf822b3/
78+
│ ├─ 28ebd981-80ae-467f-b700-ba00e7c1e3ee
79+
│ ├─ e47e5b46-d4e3-4bf1-a413-9fc71ec9f6b0
80+
│ ├─ ...
81+
├─ 66632a45658c93af0895a70e/
82+
├─ .../
83+
```

0 commit comments

Comments
 (0)