dapr
/
docs
mirror of https://github.com/dapr/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add list doc and align doc with latest changes

This commit is contained in:
Christian.Kaps 2021-07-12 12:21:16 +02:00
parent a88a0ac391
commit 5672404113
1 changed files with 121 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

140
daprdocs/content/en/reference/components-reference/supported-bindings/blobstorage.md
View File

@ -41,11 +41,11 @@ The above example uses secrets as plain strings. It is recommended to use a secr
| Field | Required | Binding support | Details | Example | | Field | Required | Binding support | Details | Example |
|--------------------|:--------:|--------|---------|---------| |--------------------|:--------:|--------|---------|---------|
| storageAccount | Y | Output | The Blob Storage account name | `"myexmapleaccount"` | | storageAccount | Y | Output | The Blob Storage account name | `myexmapleaccount` |
| storageAccessKey | Y | Output | The Blob Storage access key | `"access-key"` | | storageAccessKey | Y | Output | The Blob Storage access key | `access-key` |
| container | Y | Output | The name of the Blob Storage container to write to | `"myexamplecontainer"` | | container | Y | Output | The name of the Blob Storage container to write to | `myexamplecontainer` |
| decodeBase64 | N | Output | Configuration to decode base64 file content before saving to Blob Storage. (In case of saving a file with binary content). `"true"` is the only allowed positive value. Other positive variations like `"True"` are not acceptable. Defaults to `"false"` | `"true"`, `"false"` | | decodeBase64 | N | Output | Configuration to decode base64 file content before saving to Blob Storage. (In case of saving a file with binary content). `true` is the only allowed positive value. Other positive variations like `"True", "1"` are not acceptable. Defaults to `false` | `true`, `false` |
| getBlobRetryCount | N | Output | Specifies the maximum number of HTTP GET requests that will be made while reading from a RetryReader Defaults to `"10"` | `"1"`, `"2"` | getBlobRetryCount | N | Output | Specifies the maximum number of HTTP GET requests that will be made while reading from a RetryReader Defaults to `10` | `1`, `2`
## Binding support ## Binding support
@ -55,6 +55,7 @@ This component supports **output binding** with the following operations:
- `create` : [Create blob](#create-blob) - `create` : [Create blob](#create-blob)
- `get` : [Get blob](#get-blob) - `get` : [Get blob](#get-blob)
- `delete` : [Delete blob](#delete-blob) - `delete` : [Delete blob](#delete-blob)
- `list`: [List blobs](#list-blobs)
### Create blob ### Create blob
@ -133,7 +134,7 @@ spec:
- name: container - name: container
value: container1 value: container1
- name: decodeBase64 - name: decodeBase64
value: "true" value: true
``` ```
Then you can upload it as you would normally: Then you can upload it as you would normally:
@ -175,7 +176,7 @@ To perform a get blob operation, invoke the Azure Blob Storage binding with a `P
"operation": "get", "operation": "get",
"metadata": { "metadata": {
"blobName": "myblob", "blobName": "myblob",
"withUserMetadata": "true" "includeMetadata": "true"
} }
} }
``` ```
@ -183,7 +184,7 @@ To perform a get blob operation, invoke the Azure Blob Storage binding with a `P
The metadata parameters are: The metadata parameters are:
- `blobName` - the name of the blob - `blobName` - the name of the blob
- `withUserMetadata`- (optional) defines if the user metadata should be returned or not, defaults to: false - `includeMetadata`- (optional) defines if the user defined metadata should be returned or not, defaults to: false
#### Example #### Example
@ -227,6 +228,9 @@ To perform a delete blob operation, invoke the Azure Blob Storage binding with a
The metadata parameters are: The metadata parameters are:
- `blobName` - the name of the blob - `blobName` - the name of the blob
- `deleteSnapshots` - (optional) required if the blob has associated snapshots. Specify one of the following two options:
- include: Delete the base blob and all of its snapshots
- only: Delete only the blob's snapshots and not the blob itself
#### Examples #### Examples
@ -255,13 +259,13 @@ The metadata parameters are:
{{% codetab %}} {{% codetab %}}
```bash ```bash
curl -d '{ \"operation\": \"delete\", \"metadata\": { \"blobName\": \"myblob\", \"DeleteSnapshotOptions\": \"only\" }}' http://localhost:<dapr-port>/v1.0/bindings/<binding-name> curl -d '{ \"operation\": \"delete\", \"metadata\": { \"blobName\": \"myblob\", \"deleteSnapshots\": \"only\" }}' http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
``` ```
{{% /codetab %}} {{% /codetab %}}
{{% codetab %}} {{% codetab %}}
```bash ```bash
curl -d '{ "operation": "delete", "metadata": { "blobName": "myblob", "DeleteSnapshotOptions": "only" }}' \ curl -d '{ "operation": "delete", "metadata": { "blobName": "myblob", "deleteSnapshots": "only" }}' \
http://localhost:<dapr-port>/v1.0/bindings/<binding-name> http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
``` ```
{{% /codetab %}} {{% /codetab %}}
@ -274,13 +278,13 @@ The metadata parameters are:
{{% codetab %}} {{% codetab %}}
```bash ```bash
curl -d '{ \"operation\": \"delete\", \"metadata\": { \"blobName\": \"myblob\", \"DeleteSnapshotOptions\": \"include\" }}' http://localhost:<dapr-port>/v1.0/bindings/<binding-name> curl -d '{ \"operation\": \"delete\", \"metadata\": { \"blobName\": \"myblob\", \"deleteSnapshots\": \"include\" }}' http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
``` ```
{{% /codetab %}} {{% /codetab %}}
{{% codetab %}} {{% codetab %}}
```bash ```bash
curl -d '{ "operation": "delete", "metadata": { "blobName": "myblob", "DeleteSnapshotOptions": "include" }}' \ curl -d '{ "operation": "delete", "metadata": { "blobName": "myblob", "deleteSnapshots": "include" }}' \
http://localhost:<dapr-port>/v1.0/bindings/<binding-name> http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
``` ```
{{% /codetab %}} {{% /codetab %}}
@ -291,6 +295,104 @@ The metadata parameters are:
An HTTP 204 (No Content) and empty body will be retuned if successful. An HTTP 204 (No Content) and empty body will be retuned if successful.
### List blobs
To perform a list blobs operation, invoke the Azure Blob Storage binding with a `POST` method and the following JSON body:
```json
{
"operation": "list",
"data": {
"maxResults": 10,
"prefix": "file",
"marker": "2!108!MDAwMDM1IWZpbGUtMDgtMDctMjAyMS0wOS0zOC01NS03NzgtMjEudHh0ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--",
"include": {
"snapshots": false,
"metadata": true,
"uncommittedBlobs": false,
"copy": false,
"deleted": false
}
}
}
```
The data parameters are:
- `maxResults` - (optional) specifies the maximum number of blobs to return, including all BlobPrefix elements. If the request does not specify maxresults the server will return up to 5,000 items.
- `prefix` - (optional) filters the results to return only blobs whose names begin with the specified prefix.
- `marker` - (optional) a string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items.
- `include` - (optional) Specifies one or more datasets to include in the response:
- snapshots: Specifies that snapshots should be included in the enumeration. Snapshots are listed from oldest to newest in the response. Defaults to: false
- metadata: Specifies that blob metadata be returned in the response. Defaults to: false
- uncommittedBlobs: Specifies that blobs for which blocks have been uploaded, but which have not been committed using Put Block List, be included in the response. Defaults to: false
- copy: Version 2012-02-12 and newer. Specifies that metadata related to any current or previous Copy Blob operation should be included in the response. Defaults to: false
- deleted: Version 2017-07-29 and newer. Specifies that soft deleted blobs should be included in the response. Defaults to: false
#### Response
The response body contains the list of found blocks as also the following HTTP headers:
`Metadata.marker: 2!108!MDAwMDM1IWZpbGUtMDgtMDctMjAyMS0wOS0zOC0zNC04NjctMTEudHh0ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--`
`Metadata.number: 10`
- `marker` - the next marker which can be used in a subsequent call to request the next set of list items. See the marker description on the data property of the binding input.
- `number` - the number of found blobs
The list of blobs will be returned as JSON array in the following form:
```json
[
{
"XMLName": {
"Space": "",
"Local": "Blob"
},
"Name": "file-08-07-2021-09-38-13-776-1.txt",
"Deleted": false,
"Snapshot": "",
"Properties": {
"XMLName": {
"Space": "",
"Local": "Properties"
},
"CreationTime": "2021-07-08T07:38:16Z",
"LastModified": "2021-07-08T07:38:16Z",
"Etag": "0x8D941E3593C6573",
"ContentLength": 1,
"ContentType": "application/octet-stream",
"ContentEncoding": "",
"ContentLanguage": "",
"ContentMD5": "xMpCOKC5I4INzFCab3WEmw==",
"ContentDisposition": "",
"CacheControl": "",
"BlobSequenceNumber": null,
"BlobType": "BlockBlob",
"LeaseStatus": "unlocked",
"LeaseState": "available",
"LeaseDuration": "",
"CopyID": null,
"CopyStatus": "",
"CopySource": null,
"CopyProgress": null,
"CopyCompletionTime": null,
"CopyStatusDescription": null,
"ServerEncrypted": true,
"IncrementalCopy": null,
"DestinationSnapshot": null,
"DeletedTime": null,
"RemainingRetentionDays": null,
"AccessTier": "Hot",
"AccessTierInferred": true,
"ArchiveStatus": "",
"CustomerProvidedKeySha256": null,
"AccessTierChangeTime": null
},
"Metadata": null
}
]
```
## Metadata information ## Metadata information
By default the Azure Blob Storage output binding auto generates a UUID as the blob filename and is not assigned any system or custom metadata to it. It is configurable in the metadata property of the message (all optional). By default the Azure Blob Storage output binding auto generates a UUID as the blob filename and is not assigned any system or custom metadata to it. It is configurable in the metadata property of the message (all optional).
@ -302,13 +404,13 @@ Applications publishing to an Azure Blob Storage output binding should send a me
"data": "file content", "data": "file content",
"metadata": { "metadata": {
"blobName" : "filename.txt", "blobName" : "filename.txt",
"ContentType" : "text/plain", "contentType" : "text/plain",
"ContentMD5" : "vZGKbMRDAnMs4BIwlXaRvQ==", "contentMD5" : "vZGKbMRDAnMs4BIwlXaRvQ==",
"ContentEncoding" : "UTF-8", "contentEncoding" : "UTF-8",
"ContentLanguage" : "en-us", "contentLanguage" : "en-us",
"ContentDisposition" : "attachment", "contentDisposition" : "attachment",
"CacheControl" : "no-cache", "cacheControl" : "no-cache",
"Custom" : "hello-world", "custom" : "hello-world"
}, },
"operation": "create" "operation": "create"
} }