From c112151ae925ed220f06332351eb794c5ca4326f Mon Sep 17 00:00:00 2001 From: Hannah Hunter Date: Thu, 13 Feb 2025 11:00:33 -0500 Subject: [PATCH 1/2] add metadata to event hubs binding spec Signed-off-by: Hannah Hunter --- .../components-reference/supported-bindings/eventhubs.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/daprdocs/content/en/reference/components-reference/supported-bindings/eventhubs.md b/daprdocs/content/en/reference/components-reference/supported-bindings/eventhubs.md index be8536f7267..0a1bde2bbfa 100644 --- a/daprdocs/content/en/reference/components-reference/supported-bindings/eventhubs.md +++ b/daprdocs/content/en/reference/components-reference/supported-bindings/eventhubs.md @@ -58,6 +58,8 @@ spec: - name: storageConnectionString value: "DefaultEndpointsProtocol=https;AccountName=;AccountKey=" # Optional metadata + - name: getAllMessageProperties + value: "true" - name: direction value: "input, output" ``` @@ -84,6 +86,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr | `storageAccountKey` | Y* | Input | Storage account key for the checkpoint store account.
* When using Microsoft Entra ID, it's possible to omit this if the service principal has access to the storage account too. | `"112233445566778899"` | `storageConnectionString` | Y* | Input | Connection string for the checkpoint store, alternative to specifying `storageAccountKey` | `"DefaultEndpointsProtocol=https;AccountName=myeventhubstorage;AccountKey="` | `storageContainerName` | Y | Input | Storage container name for the storage account name. | `"myeventhubstoragecontainer"` +| `getAllMessageProperties` | N | Input | When set to `true`, retrieves all message properties and includes them in the returned event metadata. Default setting is `"false"`. | `"true"`, `"false"` | `direction` | N | Input/Output | The direction of the binding. | `"input"`, `"output"`, `"input, output"` ### Microsoft Entra ID authentication From 77830b72ea61f3fd0657bddd3a7c9eb8d37f915c Mon Sep 17 00:00:00 2001 From: Hannah Hunter Date: Thu, 13 Feb 2025 17:42:00 -0500 Subject: [PATCH 2/2] reword Signed-off-by: Hannah Hunter --- .../components-reference/supported-bindings/eventhubs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/content/en/reference/components-reference/supported-bindings/eventhubs.md b/daprdocs/content/en/reference/components-reference/supported-bindings/eventhubs.md index 0a1bde2bbfa..08215f0e1d9 100644 --- a/daprdocs/content/en/reference/components-reference/supported-bindings/eventhubs.md +++ b/daprdocs/content/en/reference/components-reference/supported-bindings/eventhubs.md @@ -86,7 +86,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr | `storageAccountKey` | Y* | Input | Storage account key for the checkpoint store account.
* When using Microsoft Entra ID, it's possible to omit this if the service principal has access to the storage account too. | `"112233445566778899"` | `storageConnectionString` | Y* | Input | Connection string for the checkpoint store, alternative to specifying `storageAccountKey` | `"DefaultEndpointsProtocol=https;AccountName=myeventhubstorage;AccountKey="` | `storageContainerName` | Y | Input | Storage container name for the storage account name. | `"myeventhubstoragecontainer"` -| `getAllMessageProperties` | N | Input | When set to `true`, retrieves all message properties and includes them in the returned event metadata. Default setting is `"false"`. | `"true"`, `"false"` +| `getAllMessageProperties` | N | Input | When set to `true`, retrieves all user/app/custom properties from the Event Hub message and forwards them in the returned event metadata. Default setting is `"false"`. | `"true"`, `"false"` | `direction` | N | Input/Output | The direction of the binding. | `"input"`, `"output"`, `"input, output"` ### Microsoft Entra ID authentication