You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ravi.periketi 6ecb551b5b Merge pull request 'feature/init' (#1) from feature/init into master 7 months ago
examples fix reviews 7 months ago
.gitignore init commit 8 months ago
.pre-commit-config.yaml update CHGANGELOG.md 7 months ago
CHANGELOG.md update CHGANGELOG.md 7 months ago
Jenkinsfile add jenkinsfile 8 months ago
LICENSE init commit 8 months ago
README.md fix reviews 7 months ago
main.tf fix reviews 7 months ago
outputs.tf fix reviews 7 months ago
variables.tf fix reviews 7 months ago
versions.tf update provider version 7 months ago

README.md

terraform-module-azurerm-event-hub

Usage

See examples folders for usage of this module.

Limitation

  • Any call of this module will create resources in a single resource group.

Requirements

Name Version
terraform >= 0.12
azurerm >= 2.0.0

Providers

Name Version
azurerm >= 2.0.0

Inputs

Name Description Type Default Required
authorization_rule_event_hub_names The list of names of the eventhubs to which this authorization rule will be associated. If enabled the value is Requied. list(string)
[
““
]
no
capture_description_enabled Boolean flag list which specifies the capture description is enabled or not. list(bool)
[
false
]
no
capture_description_encoding List of encoding used for the capture description. Possible values are Avro and AvroDeflate. Value is Required if capture description is enabled. list(string)
[
“Avro"
]
no
capture_description_interval_in_seconds List of time interval in seconds at which the capture will happen. Values can be between 60 and 900 seconds. Defaults to 300 seconds. list(number)
[
300
]
no
capture_description_size_in_bytes List of amount of data built up in your EventHub before a Capture Operation occurs. Value should be between 10485760 and 524288000 bytes. Defaults to 314572800 bytes. list(number)
[
314572800
]
no
consumer_group_enabled Boolean flag which describes whether or not to enable the eventhub consumer group. bool false no
consumer_group_event_hub_names The list of names of the eventhub in which consumer groups will be created. list(string)
[
““
]
no
consumer_group_names List of names of the eventhub consumer group resource. Changing this forces a new resource to be created. If enabled value is Required. list(string)
[
““
]
no
consumer_group_user_metadatas List of user metadata. list(string)
[
“FX"
]
no
destination_archive_name_formats The list of The Blob naming convention for archiving. e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order list(string)
[
““
]
no
destination_blob_container_names The list of names of the conatianers within the blob storage account where message should be archived. If the destination block is enabled this value is Required. list(string)
[
““
]
no
destination_names The list of names of the Destination where the capture should take place. At this time the only supported value is EventHubArchive.AzureBlockBlob. If the destination is blocke is enabled value is Required. list(string)
[
“EventHubArchive.AzureBlockBlob"
]
no
destination_storage_account_ids The list of IDs of the blob storage account where messages should be archived.If the destination block is enabled this value is Required. list(string)
[
““
]
no
enabled Enable or disable module. bool true no
event_hub_enabled Boolean flag which describes whether to enable the eventub resource or not. bool false no
event_hub_existing_namesapce_disaster_recovery_names The list of names of existing eventhub namespace. Changing this will force a new recovery config to be cretaed. If event_hub_namesapce_disaster_recovery_exist is enabled then this value is Required. list(string)
[
““
]
no
event_hub_existing_namespace_names List of names of existing eventhub namespaces.Changing this forces a new resource to be created. If event_hub_namespace_exist enabled then value is Required. list(string) [] no
event_hub_message_rententions The list of number of days to retain the events for this eventhub. Needs to be between 1 and 7 days; or 1 day when using a Basic SKU for the parent eventhub namespace. list(number)
[
1
]
no
event_hub_names List of names of the eventhub resource. Chnaging this forces a new resource to be created.If enabled value is Required. list(string) [] no
event_hub_namesapce_disaster_recovery_exist Boolean flag which the describes whether the eventhub namespace for which disaster recovery config will be setup already exist or not. bool false no
event_hub_namespace_alternate_names List of alternate names to use when the diaster recovery config's name is the same as replicated namespace names. list(string)
[
““
]
no
event_hub_namespace_enabled Boolean flag which describes whether or not enable the eventhub namespace. bool false no
event_hub_namespace_exist Boolean flag which describes whether the namespace is already existing or not. bool false no
event_hub_namespace_recovery_enabled Boolean flag which describes whether or not enable recovery config for eventhub namespace. bool false no
event_hub_namespace_recovery_names List of names of the disaster recovery config. Changing this forces a new resource to be created. list(string)
[
null
]
no
event_hub_namespace_recovery_partner_namespace_ids The list of IDs of the eventhub namespace to replicate to. list(string)
[
““
]
no
event_hub_partititon_counts List of current number of shards on event hub. Changing this forces a new resource to be created. If enabled value is Required. list(number)
[
2
]
no
event_hub_recovery_namespace_names List of names of eventhub namespaces to which disaster recovery config is done.Changing this forces a new resource to be created. list(string)
[
““
]
no
eventhub_authorization_rule_enabled The boolean flag which describes whether to enable the authorization rule for the eventhub or not. bool false no
eventhub_authorization_rule_listens List of boolean flag which describes the authorization rule have permissions to listen to eventhub? Defaults to false. list(bool)
[
false
]
no
eventhub_authorization_rule_manages Boolean flag list which describes does this authorization rule have permission to manage to the event hub? when this property is true- both listen and send must be too. Default to false. list(string)
[
false
]
no
eventhub_authorization_rule_names List of names of the eventhub authorization rule resource. Changing this forces a new resource to be created. If the rsource is enabled the Value is Required. list(string)
[
““
]
no
eventhub_authorization_rule_sends Boolean flag list which describes the does the authorization rule have permission to send to the eventhub? Default to flase. list(string)
[
false
]
no
eventhub_namespace_auto_inflate_enabled Boolean flag which describes whether the auto inflate enabled for the eventhub namespace. bool false no
eventhub_namespace_capacitiy Specifies the capacity/throughput units for a Standard SKU namespace. Valid values range from 1-20. number 5 no
eventhub_namespace_location Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. If enabled value is REQUIRED. string "" no
eventhub_namespace_maximum_throughput_units Specifies the maximum number of throughput units when auto inflate is enabled. Valid values range from 1-20. number 5 no
eventhub_namespace_name Specifies the name of the EventHub Namespace resource. Changing this forces a new resource to be created. If enabled values is REQUIRED. string "" no
eventhub_namespace_sku Defines which tier to use. Valid options are Basic and Standard. If enabled value is REQUIRED. string "Basic" no
eventhub_namespace_tags Tags which will be associated to the eventhub namespace. map {} no
existing_event_hub_names The list of names of existing eventhubs. Changing forces a new to be created. list(string) [] no
namespace_authorization_rule_enabled Boolean flag which describes whether to enable the namespace authorization rules or not. bool false no
namespace_authorization_rule_listens The list of boolean flags which describes whether to grant listen access to authorization rule. Defaults to false. list(bool)
[
false
]
no
namespace_authorization_rule_manages The list of boolean flags which describes whether to grant send access to authorization rule.When this property is ture both listen and send must be too. Defaults to false. list(bool)
[
false
]
no
namespace_authorization_rule_names The list which specifies the names of the authorization rule. Changing this forces a new resourece to be created. If enabled value is Required. list(string)
[
““
]
no
namespace_authorization_rule_sends The list of boolean flags which describes whether to grant send access to authorization rule. Defaults to false. list(bool)
[
false
]
no
network_rulesets One or more network rulesets.Network rulesets cannot be used be when sku is set to Basic list(object({ default_action = string, ip_mask = string, subnet_id = string, ignore_missing_virtual_network_service_endpoint = bool })) null no
resource_group_name Name of the resource group of the eventhub namespace resources should be exist.Changing this forces a new resource to be created. string "" no
tags Tags shared by all resources of this module. Will be merged with any other specific tags by resource. map {} no

Outputs

Name Description
event_hub_ids IDs of the event hub.
event_hub_partition_ids Identifiers for partitions created for the eventhub.
eventhub_authorization_rule_ids IDs of the eventhub authorization rules.
eventhub_authorization_rule_primary_connection_string The primary connection string for the authorization rules.
eventhub_authorization_rule_primary_key The primary keys for the authorization rules.
eventhub_authorization_rule_secondary_connection_string The secondary connection string for the authorization rules.
eventhub_authorization_rule_secondary_key The secondary keys for the authorization rules.
eventhub_consumer_group_ids IDs of the eventhub consumer group.
eventhub_namespace_id The ID of the event hub namespace.
namesapce_authorization_rule_primary_key The primary keys for the authorization rules.
namespace_authorization_rule_ids IDs of the namespace authorization rules.
namespace_authorization_rule_primary_connection_string The primary connection string for the authorization rules.
namespace_authorization_rule_secondary_connection_string The secondary connection string for the authorization rules.
namespace_authorization_rule_secondary_key The secondary keys for the authorization rules.
recovery_eventhub_namespace_ids IDs of the eventhub namespace diaster recovery config.