.. _param-omazureeventhubs-azure_key_name:
.. _omazureeventhubs.parameter.input.azure_key_name:

azure_key_name
==============

.. index::
   single: omazureeventhubs; azure_key_name
   single: azure_key_name

.. summary-start

Specifies the shared access key name used to authenticate with Event Hubs.

.. summary-end

This parameter applies to :doc:`../../configuration/modules/omazureeventhubs`.

:Name: azure_key_name
:Scope: input
:Type: word
:Default: input=none
:Required?: no
:Introduced: v8.2304

Description
-----------
Specifies the "Event Hubs shared access key name" (the shared access policy
name) used to authenticate and authorize connections to the Event Hubs
instance. Provide this value unless ``amqp_address`` already supplies the
credentials.

Input usage
-----------
.. _omazureeventhubs.parameter.input.azure_key_name-usage:

.. code-block:: rsyslog

   action(type="omazureeventhubs" azure_key_name="MyPolicy" ...)

See also
--------
See also :doc:`../../configuration/modules/omazureeventhubs`.
