Microsoft Azure Event Hubs policy
A Microsoft Azure Event Hubs policy contains the connection details that are used by a Microsoft Azure Event Hubs Input node or a Microsoft Azure Event Hubs Request node when connecting to a Microsoft Azure Event Hubs application.
You can use a Microsoft Azure Event Hubs Input node in a message flow to accept input from Microsoft Azure Event Hubs. You can use the node to monitor Microsoft Azure Event Hubs for new messages. Use a Microsoft Azure Event Hubs Request node in a message flow to connect IBM® App Connect Enterprise to Microsoft Azure Event Hubs and issue requests to create, retrieve, update, send, and delete objects such as consumer groups, messages, event hubs, and partitions. The Microsoft Azure Event Hubs policy controls, at run time, access to the Microsoft Azure Event Hubs application.
The Microsoft
Azure Event Hubs policy is created when
you configure a connection between an Microsoft
Azure Event Hubs Input node or Microsoft
Azure Event Hubs Request node and Microsoft
Azure Event Hubs by using the Connector Discovery
wizard. During the process of discovery, account credentials are stored in the vault and connection
details are stored in an Microsoft
Azure Event Hubs policy.
The policy is created with a type of Microsoft Azure Event Hubs, and the name of
the policy is returned to the Microsoft
Azure Event Hubs Request
node and specified in the Connection tab, in the format
{policyProjectName}:policyName.
You can also create, update, or delete a Microsoft Azure Event Hubs policy by using the Manage Discovery Connector Policies and Credentials wizard, which you can access by right-clicking the policy project in the IBM App Connect Enterprise Toolkit and then clicking .
You must deploy this policy before message flows that use the policy are started. If you redeploy an Microsoft Azure Event Hubs policy, all message flows that are using the policy will be stopped and restarted.
For more information about using Microsoft Azure Event Hubs, see Using Microsoft Azure Event Hubs with IBM App Connect Enterprise.
| Property | Property name in .policyxml file | Description of properties |
|---|---|---|
| Microsoft Azure Event Hubs Application Type | applicationType | This property is reserved for future use and must be set to the value
online. |
| Microsoft Azure Event Hubs Application Version | applicationVersion | This property is reserved for future use and must be set to the value
v1. |
| Microsoft Azure Event Hubs Authentication method | authenticationMethod | This property specifies the type of authentication that is used for the
connection between IBM App Connect Enterprise and Microsoft
Azure Event Hubs. This value is reserved for future
use and must be set to BASIC_OAUTH. |
| Credential Name | credentialName | The name of your Microsoft
Azure Event Hubs account. For example,
microsoftazureeventhubspolicy_MicrosoftAzureEventHubs |
| Tenant ID | tenantId | The unique identifier for your Microsoft Entra tenant. |
| Subscription ID | roleArn | The unique identifier for your Azure subscription. It is used to identify which subscription your Azure Event Hubs resources belong to. |
| Resource group name | role | The name of the resource group that contains your Azure Event Hubs resources. Resource groups are logical containers for Azure resources. |
| Namespace name | region | The name of the Azure Event Hubs namespace. A namespace is a container for Event Hubs and provides a scoping container for addressing Event Hubs within your Azure subscription. |
| Proxy name | proxyId | The name of the proxy that you want App Connect to use to pass the connector
calls. This field is only required if calls need to go through a proxy. When using the IBM App
Connect Enterprise Toolkit, the proxy name should be specified in the form:
{PolicyProjectName}:HTTPProxyPolicyName |