mirror of https://github.com/dapr/docs.git
Add metadata doc to Azure Blob binding (#450)
* add metadata doc to AzBlobBinding * fix securely typo and ensure prod note on all specs Co-authored-by: Yaron Schneider <yaronsc@microsoft.com>
This commit is contained in:
parent
f4ac7af97f
commit
7ba5e7557a
|
@ -20,4 +20,27 @@ spec:
|
||||||
- `storageAccessKey` is the Blob Storage access key.
|
- `storageAccessKey` is the Blob Storage access key.
|
||||||
- `container` is the name of the Blob Storage container to write to.
|
- `container` is the name of the Blob Storage container to write to.
|
||||||
|
|
||||||
> **Note:** In production never place passwords or secrets within Dapr components. For information on securly storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
> **Note:** In production never place passwords or secrets within Dapr components. For information on securely storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
||||||
|
|
||||||
|
## Additional information
|
||||||
|
|
||||||
|
By default the Azure Blob Storage output binding will auto generate a UUID as blob filename and not assign any system or custom metadata to it. It is configurable in the Metadata property of the message (all optional).
|
||||||
|
|
||||||
|
Applications publishing to an Azure Blob Storage output binding should send a message with the following contract:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"data": {
|
||||||
|
"message": "Hi"
|
||||||
|
},
|
||||||
|
"metadata": {
|
||||||
|
"blobName" : "filename.txt",
|
||||||
|
"ContentType" : "text/plain",
|
||||||
|
"ContentMD5" : "vZGKbMRDAnMs4BIwlXaRvQ==",
|
||||||
|
"ContentEncoding" : "UTF-8",
|
||||||
|
"ContentLanguage" : "en-us",
|
||||||
|
"ContentDisposition" : "attachment",
|
||||||
|
"CacheControl" : "no-cache",
|
||||||
|
"Custom" : "hello-world",
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
|
@ -26,4 +26,4 @@ spec:
|
||||||
- `collection` is name of the collection inside the database.
|
- `collection` is name of the collection inside the database.
|
||||||
- `partitionKey` is the name of the partitionKey to extract from the payload.
|
- `partitionKey` is the name of the partitionKey to extract from the payload.
|
||||||
|
|
||||||
> **Note:** In production never place passwords or secrets within Dapr components. For information on securly storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
> **Note:** In production never place passwords or secrets within Dapr components. For information on securely storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
|
@ -23,4 +23,4 @@ spec:
|
||||||
- `secretKey` is the AWS secret key.
|
- `secretKey` is the AWS secret key.
|
||||||
- `table` is the DynamoDB table name.
|
- `table` is the DynamoDB table name.
|
||||||
|
|
||||||
> **Note:** In production never place passwords or secrets within Dapr components. For information on securly storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
> **Note:** In production never place passwords or secrets within Dapr components. For information on securely storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
|
@ -31,4 +31,4 @@ spec:
|
||||||
- `storageContainerName` Is the name of the container in the Azure Storage account to persist checkpoints data on.
|
- `storageContainerName` Is the name of the container in the Azure Storage account to persist checkpoints data on.
|
||||||
- `partitionID` (Optional) ID of the partition to send and receive events.
|
- `partitionID` (Optional) ID of the partition to send and receive events.
|
||||||
|
|
||||||
> **Note:** In production never place passwords or secrets within Dapr components. For information on securly storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
> **Note:** In production never place passwords or secrets within Dapr components. For information on securely storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
||||||
|
|
|
@ -44,4 +44,4 @@ spec:
|
||||||
- `client_x509_cert_url` is the GCP credentials project x509 cert url.
|
- `client_x509_cert_url` is the GCP credentials project x509 cert url.
|
||||||
- `private_key` is the GCP credentials private key.
|
- `private_key` is the GCP credentials private key.
|
||||||
|
|
||||||
> **Note:** In production never place passwords or secrets within Dapr components. For information on securly storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
> **Note:** In production never place passwords or secrets within Dapr components. For information on securely storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
|
@ -47,4 +47,4 @@ spec:
|
||||||
- `client_x509_cert_url` is the GCP credentials project x509 cert url.
|
- `client_x509_cert_url` is the GCP credentials project x509 cert url.
|
||||||
- `private_key` is the GCP credentials private key.
|
- `private_key` is the GCP credentials private key.
|
||||||
|
|
||||||
> **Note:** In production never place passwords or secrets within Dapr components. For information on securly storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
> **Note:** In production never place passwords or secrets within Dapr components. For information on securely storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
|
@ -32,4 +32,4 @@ spec:
|
||||||
- `saslUsername` is the SASL username for authentication. Only used if `authRequired` is set to - `"true"`.
|
- `saslUsername` is the SASL username for authentication. Only used if `authRequired` is set to - `"true"`.
|
||||||
- `saslPassword` is the SASL password for authentication. Only used if `authRequired` is set to - `"true"`.
|
- `saslPassword` is the SASL password for authentication. Only used if `authRequired` is set to - `"true"`.
|
||||||
|
|
||||||
> **Note:** In production never place passwords or secrets within Dapr components. For information on securly storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
> **Note:** In production never place passwords or secrets within Dapr components. For information on securely storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
|
@ -16,3 +16,5 @@ spec:
|
||||||
|
|
||||||
- `url` is the MQTT broker url.
|
- `url` is the MQTT broker url.
|
||||||
- `topic` is the topic to listen on or send events to.
|
- `topic` is the topic to listen on or send events to.
|
||||||
|
|
||||||
|
> **Note:** In production never place passwords or secrets within Dapr components. For information on securely storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
|
@ -11,7 +11,7 @@ spec:
|
||||||
- name: queueName
|
- name: queueName
|
||||||
value: queue1
|
value: queue1
|
||||||
- name: host
|
- name: host
|
||||||
value: amqp://guest:guest@localhost:5672
|
value: amqp://[username][:password]@host.domain[:port]
|
||||||
- name: durable
|
- name: durable
|
||||||
value: true
|
value: true
|
||||||
- name: deleteWhenUnused
|
- name: deleteWhenUnused
|
||||||
|
@ -21,4 +21,6 @@ spec:
|
||||||
- `queueName` is the RabbitMQ queue name.
|
- `queueName` is the RabbitMQ queue name.
|
||||||
- `host` is the RabbitMQ host address.
|
- `host` is the RabbitMQ host address.
|
||||||
- `durable` tells RabbitMQ to persist message in storage.
|
- `durable` tells RabbitMQ to persist message in storage.
|
||||||
- `deleteWhenUnused` enables or disables auto-delete.
|
- `deleteWhenUnused` enables or disables auto-delete.
|
||||||
|
|
||||||
|
> **Note:** In production never place passwords or secrets within Dapr components. For information on securely storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
|
@ -17,4 +17,4 @@ spec:
|
||||||
- `redisHost` is the Redis host address.
|
- `redisHost` is the Redis host address.
|
||||||
- `redisPassword` is the Redis password.
|
- `redisPassword` is the Redis password.
|
||||||
|
|
||||||
> **Note:** In production never place passwords or secrets within Dapr components. For information on securly storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
> **Note:** In production never place passwords or secrets within Dapr components. For information on securely storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
||||||
|
|
|
@ -23,4 +23,4 @@ spec:
|
||||||
- `secretKey` is the AWS secret key.
|
- `secretKey` is the AWS secret key.
|
||||||
- `table` is the name of the S3 bucket to write to.
|
- `table` is the name of the S3 bucket to write to.
|
||||||
|
|
||||||
> **Note:** In production never place passwords or secrets within Dapr components. For information on securly storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
> **Note:** In production never place passwords or secrets within Dapr components. For information on securely storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
|
@ -17,4 +17,4 @@ spec:
|
||||||
- `connectionString` is the Service Bus connection string.
|
- `connectionString` is the Service Bus connection string.
|
||||||
- `queueName` is the Service Bus queue name.
|
- `queueName` is the Service Bus queue name.
|
||||||
|
|
||||||
> **Note:** In production never place passwords or secrets within Dapr components. For information on securly storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
> **Note:** In production never place passwords or secrets within Dapr components. For information on securely storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
|
@ -17,7 +17,7 @@ spec:
|
||||||
- The metadata `connectionString` contains the Azure SignalR connection string.
|
- The metadata `connectionString` contains the Azure SignalR connection string.
|
||||||
- The optional `hub` metadata value defines the hub in which the message will be send. The hub can be dynamically defined as a metadata value when publishing to an output binding (key is "hub").
|
- The optional `hub` metadata value defines the hub in which the message will be send. The hub can be dynamically defined as a metadata value when publishing to an output binding (key is "hub").
|
||||||
|
|
||||||
> **Note:** In production never place passwords or secrets within Dapr components. For information on securly storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
> **Note:** In production never place passwords or secrets within Dapr components. For information on securely storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
||||||
|
|
||||||
## Additional information
|
## Additional information
|
||||||
|
|
||||||
|
|
|
@ -23,4 +23,4 @@ spec:
|
||||||
- `secretKey` is the AWS secret key.
|
- `secretKey` is the AWS secret key.
|
||||||
- `topicArn` is the SNS topic name.
|
- `topicArn` is the SNS topic name.
|
||||||
|
|
||||||
> **Note:** In production never place passwords or secrets within Dapr components. For information on securly storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
> **Note:** In production never place passwords or secrets within Dapr components. For information on securely storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
|
@ -23,4 +23,4 @@ spec:
|
||||||
- `secretKey` is the AWS secret key.
|
- `secretKey` is the AWS secret key.
|
||||||
- `queueName` is the SQS queue name.
|
- `queueName` is the SQS queue name.
|
||||||
|
|
||||||
> **Note:** In production never place passwords or secrets within Dapr components. For information on securly storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
> **Note:** In production never place passwords or secrets within Dapr components. For information on securely storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
|
@ -16,6 +16,8 @@ spec:
|
||||||
value: "myqueue"
|
value: "myqueue"
|
||||||
```
|
```
|
||||||
|
|
||||||
`storageAccount` is the Azure Storage account name.
|
- `storageAccount` is the Azure Storage account name.
|
||||||
`storageAccessKey` is the Azure Storage access key.
|
- `storageAccessKey` is the Azure Storage access key.
|
||||||
`queue` is the name of the Azure Storage queue.
|
- `queue` is the name of the Azure Storage queue.
|
||||||
|
|
||||||
|
> **Note:** In production never place passwords or secrets within Dapr components. For information on securely storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
|
@ -23,4 +23,4 @@ spec:
|
||||||
- `accountSid` is the Twilio account SID.
|
- `accountSid` is the Twilio account SID.
|
||||||
- `authToken` is the Twilio auth token.
|
- `authToken` is the Twilio auth token.
|
||||||
|
|
||||||
> **Note:** In production never place passwords or secrets within Dapr components. For information on securly storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
> **Note:** In production never place passwords or secrets within Dapr components. For information on securely storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)
|
Loading…
Reference in New Issue