diff --git a/reference/specs/bindings/blobstorage.md b/reference/specs/bindings/blobstorage.md index a8220e1f0..8976e8736 100644 --- a/reference/specs/bindings/blobstorage.md +++ b/reference/specs/bindings/blobstorage.md @@ -20,4 +20,27 @@ spec: - `storageAccessKey` is the Blob Storage access key. - `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) \ No newline at end of file +> **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", + } +} +``` \ No newline at end of file diff --git a/reference/specs/bindings/cosmosdb.md b/reference/specs/bindings/cosmosdb.md index 2ba67673b..d38a43440 100644 --- a/reference/specs/bindings/cosmosdb.md +++ b/reference/specs/bindings/cosmosdb.md @@ -26,4 +26,4 @@ spec: - `collection` is name of the collection inside the database. - `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) \ No newline at end of file +> **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) \ No newline at end of file diff --git a/reference/specs/bindings/dynamodb.md b/reference/specs/bindings/dynamodb.md index 94b0bdfbf..dcf5fb18d 100644 --- a/reference/specs/bindings/dynamodb.md +++ b/reference/specs/bindings/dynamodb.md @@ -23,4 +23,4 @@ spec: - `secretKey` is the AWS secret key. - `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) \ No newline at end of file +> **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) \ No newline at end of file diff --git a/reference/specs/bindings/eventhubs.md b/reference/specs/bindings/eventhubs.md index 33bb267f0..2c4e6d9d3 100644 --- a/reference/specs/bindings/eventhubs.md +++ b/reference/specs/bindings/eventhubs.md @@ -31,4 +31,4 @@ spec: - `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. -> **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) diff --git a/reference/specs/bindings/gcpbucket.md b/reference/specs/bindings/gcpbucket.md index 0e61232fb..e9350f004 100644 --- a/reference/specs/bindings/gcpbucket.md +++ b/reference/specs/bindings/gcpbucket.md @@ -44,4 +44,4 @@ spec: - `client_x509_cert_url` is the GCP credentials project x509 cert url. - `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) \ No newline at end of file +> **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) \ No newline at end of file diff --git a/reference/specs/bindings/gcppubsub.md b/reference/specs/bindings/gcppubsub.md index 93daae31b..d5331744e 100644 --- a/reference/specs/bindings/gcppubsub.md +++ b/reference/specs/bindings/gcppubsub.md @@ -47,4 +47,4 @@ spec: - `client_x509_cert_url` is the GCP credentials project x509 cert url. - `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) \ No newline at end of file +> **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) \ No newline at end of file diff --git a/reference/specs/bindings/kafka.md b/reference/specs/bindings/kafka.md index 8af77d9dc..04fc1c8d1 100644 --- a/reference/specs/bindings/kafka.md +++ b/reference/specs/bindings/kafka.md @@ -32,4 +32,4 @@ spec: - `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"`. -> **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) \ No newline at end of file +> **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) \ No newline at end of file diff --git a/reference/specs/bindings/mqtt.md b/reference/specs/bindings/mqtt.md index 3e3164f5c..9483c1cd8 100644 --- a/reference/specs/bindings/mqtt.md +++ b/reference/specs/bindings/mqtt.md @@ -16,3 +16,5 @@ spec: - `url` is the MQTT broker url. - `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) \ No newline at end of file diff --git a/reference/specs/bindings/rabbitmq.md b/reference/specs/bindings/rabbitmq.md index 625497709..bddc6fc79 100644 --- a/reference/specs/bindings/rabbitmq.md +++ b/reference/specs/bindings/rabbitmq.md @@ -11,7 +11,7 @@ spec: - name: queueName value: queue1 - name: host - value: amqp://guest:guest@localhost:5672 + value: amqp://[username][:password]@host.domain[:port] - name: durable value: true - name: deleteWhenUnused @@ -21,4 +21,6 @@ spec: - `queueName` is the RabbitMQ queue name. - `host` is the RabbitMQ host address. - `durable` tells RabbitMQ to persist message in storage. -- `deleteWhenUnused` enables or disables auto-delete. \ No newline at end of file +- `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) \ No newline at end of file diff --git a/reference/specs/bindings/redis.md b/reference/specs/bindings/redis.md index f0d2a5e61..f95ae8f7a 100644 --- a/reference/specs/bindings/redis.md +++ b/reference/specs/bindings/redis.md @@ -17,4 +17,4 @@ spec: - `redisHost` is the Redis host address. - `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) diff --git a/reference/specs/bindings/s3.md b/reference/specs/bindings/s3.md index 84ca099a9..b7bffae79 100644 --- a/reference/specs/bindings/s3.md +++ b/reference/specs/bindings/s3.md @@ -23,4 +23,4 @@ spec: - `secretKey` is the AWS secret key. - `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) \ No newline at end of file +> **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) \ No newline at end of file diff --git a/reference/specs/bindings/servicebusqueues.md b/reference/specs/bindings/servicebusqueues.md index d1ce67ffd..3ce0c499d 100644 --- a/reference/specs/bindings/servicebusqueues.md +++ b/reference/specs/bindings/servicebusqueues.md @@ -17,4 +17,4 @@ spec: - `connectionString` is the Service Bus connection string. - `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) \ No newline at end of file +> **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) \ No newline at end of file diff --git a/reference/specs/bindings/signalr.md b/reference/specs/bindings/signalr.md index 08fd1f2aa..6c9003993 100644 --- a/reference/specs/bindings/signalr.md +++ b/reference/specs/bindings/signalr.md @@ -17,7 +17,7 @@ spec: - 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"). -> **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 diff --git a/reference/specs/bindings/sns.md b/reference/specs/bindings/sns.md index 3d52fddf5..fb86e2769 100644 --- a/reference/specs/bindings/sns.md +++ b/reference/specs/bindings/sns.md @@ -23,4 +23,4 @@ spec: - `secretKey` is the AWS secret key. - `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) \ No newline at end of file +> **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) \ No newline at end of file diff --git a/reference/specs/bindings/sqs.md b/reference/specs/bindings/sqs.md index 8de8862a7..e13f6bb24 100644 --- a/reference/specs/bindings/sqs.md +++ b/reference/specs/bindings/sqs.md @@ -23,4 +23,4 @@ spec: - `secretKey` is the AWS secret key. - `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) \ No newline at end of file +> **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) \ No newline at end of file diff --git a/reference/specs/bindings/storagequeues.md b/reference/specs/bindings/storagequeues.md index 3578be0e9..348e2b5a6 100644 --- a/reference/specs/bindings/storagequeues.md +++ b/reference/specs/bindings/storagequeues.md @@ -16,6 +16,8 @@ spec: value: "myqueue" ``` -`storageAccount` is the Azure Storage account name. -`storageAccessKey` is the Azure Storage access key. -`queue` is the name of the Azure Storage queue. +- `storageAccount` is the Azure Storage account name. +- `storageAccessKey` is the Azure Storage access key. +- `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) \ No newline at end of file diff --git a/reference/specs/bindings/twilio.md b/reference/specs/bindings/twilio.md index 65f5c3820..2f43fd5e9 100644 --- a/reference/specs/bindings/twilio.md +++ b/reference/specs/bindings/twilio.md @@ -23,4 +23,4 @@ spec: - `accountSid` is the Twilio account SID. - `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) \ No newline at end of file +> **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) \ No newline at end of file