Azure Event Hub Reference

This topic provides reference information about the Azure Event Hub service (csb-azure-eventhubs). It details the plans, configuration parameters, and binding credentials.

Plans

The following table lists the plans available for Azure Event Hub:

Plan	Description
basic	Basic Tier, 1 Consumer group, 100 Brokered connections
standard	Standard Tier, 20 Consumer groups, 1000 Brokered connections, Additional Storage, Publisher Policies

Plan Configuration Parameters

When configuring Cloud Service Broker for Azure you can add additional plans. For how to configure plans, see Configure Services with Cloud Service Broker for Azure.

The following table lists parameters which can only be configured for additional plans:

Parameter Name	Values	Default
`name`*	The plan name	n/a
`id`*	A unique GUID	n/a
`description`*	Description of the new plan	n/a
`display_name`	Name to use when displaying plan in marketplace	n/a

^* Required

You can also add any of the configuration parameters listed in the parameters section to your plan.

Note: If you set a parameter at plan level, developers cannot change the value when creating or updating service instances.

Configuration Parameters

You can provision a service by running:

cf create-service csb-azure-eventhubs PLAN-NAME SERVICE-INSTANCE-NAME -c '{"PARAMETER-NAME": "PARAMETER-VALUE"}'

You can update the configuration parameters for a service instance by running:

cf update-service SERVICE-INSTANCE-NAME -c '{"PARAMETER-NAME": "PARAMETER-VALUE"}'

The following table lists the parameters that you can configure, using the -c flag, when provisioning a csb-azure-eventhubs service:

Parameter Name	Type	Description	Default	Operation
`instance_name`	string	The name of your Event Hub instance. This parameter has the following constraints: Maximum character length: 98 Minimum character length: 6 Allowed characters: lowercase letters and numbers	`csb-eventhubs-INSTANCE-ID`	provision and update
`resource_group`	string	The name of the resource group for the instance. After being set, this cannot be updated. This parameter has the following constraints: Maximum character length: 64 Minimum character length: 0 Allowed characters: lowercase letters and numbers	`rg-INSTANCE-NAME`	provision
`location`	string	The location of the Event Hub instance. After being set, this cannot be updated. For available locations, see the Microsoft documentation.	`westus`	provision
`azure_tenant_id`	string	The ID of the Azure tenant for the instance.	The value the operator entered for Tenant ID in Ops Manager	provision and update
`azure_subscription_id`	string	The ID of the Azure subscription for the instance.	The value the operator entered for Subscription ID in Ops Manager	provision and update
`azure_client_id`	string	The ID of the Azure service principal to authenticate for service instance creation.	The value the operator entered for Client ID in Ops Manager	provision and update
`azure_client_secret`	string	The secret (password) for the Azure service principal to authenticate for service instance creation.	The value the operator entered for Client Secret in Ops Manager.	provision and update
`skip_provider_registration`	boolean	Set to `true` to skip automatic Azure provider registration. Set if the service principal being used does not have the rights to register providers.	`false`	provision and update
`sku`	boolean	Defines which tier to use. Options are `Basic` or `Standard`.	`Basic`	provision and update
`auto_inflate_enabled`	boolean	Auto Inflate enabled for the EventHub Namespace. Options are `true` or `false`.	`false`	provision and update
`partition_count`	integer	Specifies the current number of shards on the Event Hub. Changing this forces a new resource to be created.	`2`	provision and update
`message_retention`	integer	Specifies the number of days to retain the events for this Event Hub. Must be between `1` and `7` days; or `1` day when using a Basic SKU for the parent Event Hub.	`1`	provision and update

Binding Credentials

The format for binding credentials for Azure Event Hub is as follows:

{
    "eventhub_rg_name" : "RESOURCE-GROUP",
    "namespace_name" : "EVENT-HUB-NAMESPACE",
    "eventhub_name" : "EVENT-HUB-NAME",
    "event_hub_connection_string": "Endpoint=sb://",
    "event_hub_name": "EVENT-HUB-NAME",
    "namespace_connection_string": "Endpoint=sb://EVENT-HUB-NAMESPACE",
    "shared_access_key_name": "",
    "shared_access_key_value": ""
}

Where:

RESOURCE-GROUP is the resource group containing the Event Hub namespace.
EVENT-HUB-NAMESPACE is the name of the Event Hub namespace.
EVENT-HUB-NAME is the name of the Event Hub.