Add component metadata YAML for Azure Event Hubs pubsub (#2788)

Signed-off-by: Yash Nisar <yashnisar@microsoft.com>
Co-authored-by: Bernd Verst <github@bernd.dev>
This commit is contained in:
Yash Nisar 2023-04-24 12:04:43 -05:00 committed by GitHub
parent 6e38a579fc
commit 75239e051e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 101 additions and 0 deletions

View File

@ -0,0 +1,101 @@
# yaml-language-server: $schema=../../../../component-metadata-schema.json
schemaVersion: v1
type: pubsub
name: azure.eventhubs
version: v1
status: stable
title: "Azure Event Hubs"
urls:
- title: Reference
url: https://docs.dapr.io/reference/components-reference/supported-pubsub/setup-azure-eventhubs/
authenticationProfiles:
- title: "Connection string"
description: "Authenticate using a connection string."
metadata:
- name: connectionString
required: true
sensitive: true
description: |
Connection string for the Event Hub or the Event Hub namespace.
example: '"Endpoint=sb://{EventHubNamespace}.servicebus.windows.net/;SharedAccessKeyName={PolicyName};SharedAccessKey={Key};EntityPath={EventHub}"'
builtinAuthenticationProfiles:
- name: "azuread"
metadata:
- name: eventHubNamespace
type: string
required: true
description: |
The Event Hub Namespace name.
example: '"namespace"'
- name: enableEntityManagement
type: bool
required: false
default: "false"
description: |
Allow management of the Event Hub namespace and storage account.
# The following four properties are needed only if enableEntityManagement is set to true
- name: resourceGroupName
type: string
required: false
description: |
Name of the resource group the Event Hub namespace is part of.
Required when entity management is enabled.
example: '"test-rg"'
- name: subscriptionId
type: string
required: false
description: |
Azure subscription ID value. Required when entity management is enabled
example: '"00112233-4455-6677-8899-aabbccddeeff"'
- name: messageRetentionInDays
type: number
required: false
default: "1"
example: "90"
description: |
Number of days to retain messages for in the newly created Event
Hub namespace. Used only when entity management is enabled.
- name: partitionCount
type: number
required: false
default: "1"
example: "3"
description: |
Number of partitions for the new Event Hub namespace. Used only when
entity management is enabled.
metadata:
- name: storageAccountKey
type: string
required: false
description: |
Storage account key for the checkpoint store account. When using Azure AD,
it is possible to omit this if the service principal has access to the
storage account too.
Property "storageAccountKey" is ignored when "storageConnectionString" is present
example: '"112233445566778899"'
- name: storageConnectionString
type: string
required: false
description: |
Connection string for the checkpoint store, alternative to specifying
storageAccountKey.
Property "storageAccountKey" is ignored when "storageConnectionString" is present
- name: storageAccountName
type: string
required: true
description: |
Storage account name to use for the checkpoint store.
example: '"myeventhubstorage"'
- name: storageContainerName
type: string
required: true
description: |
Storage container name.
example: '"myeventhubstoragecontainer"'
- name: consumerId
type: string
required: true # consumerGroup is an alias for this field, let's promote this to default
description: |
The name of the Event Hubs Consumer Group to listen on.
example: '"group1"'