» azurerm_eventhub
Manages a Event Hubs as a nested resource within a Event Hubs namespace.
» Example Usage
resource "azurerm_resource_group" "test" {
name = "resourceGroup1"
location = "West US"
}
resource "azurerm_eventhub_namespace" "test" {
name = "acceptanceTestEventHubNamespace"
location = "${azurerm_resource_group.test.location}"
resource_group_name = "${azurerm_resource_group.test.name}"
sku = "Standard"
capacity = 1
kafka_enabled = false
tags = {
environment = "Production"
}
}
resource "azurerm_eventhub" "test" {
name = "acceptanceTestEventHub"
namespace_name = "${azurerm_eventhub_namespace.test.name}"
resource_group_name = "${azurerm_resource_group.test.name}"
partition_count = 2
message_retention = 1
}
» Argument Reference
The following arguments are supported:
-
name
- (Required) Specifies the name of the EventHub Namespace resource. Changing this forces a new resource to be created. -
namespace_name
- (Required) Specifies the name of the EventHub Namespace. Changing this forces a new resource to be created. -
resource_group_name
- (Required) The name of the resource group in which the EventHub's parent Namespace exists. Changing this forces a new resource to be created. -
partition_count
- (Required) Specifies the current number of shards on the Event Hub. Changing this forces a new resource to be created. -
message_retention
- (Required) Specifies the number of days to retain the events for this Event Hub. Needs to be between 1 and 7 days; or 1 day when using a Basic SKU for the parent EventHub Namespace. -
capture_description
- (Optional) Acapture_description
block as defined below.
A capture_description
block supports the following:
-
enabled
- (Required) Specifies if the Capture Description is Enabled. -
encoding
- (Required) Specifies the Encoding used for the Capture Description. Possible values areAvro
andAvroDeflate
. -
interval_in_seconds
- (Optional) Specifies the time interval in seconds at which the capture will happen. Values can be between60
and900
seconds. Defaults to300
seconds. -
size_limit_in_bytes
- (Optional) Specifies the amount of data built up in your EventHub before a Capture Operation occurs. Value should be between10485760
and524288000
bytes. Defaults to314572800
bytes. -
skip_empty_archives
- (Optional) Specifies if empty files should not be emitted if no events occur during the Capture time window. Defaults tofalse
. -
destination
- (Required) Adestination
block as defined below.
A destination
block supports the following:
-
name
- (Required) The Name of the Destination where the capture should take place. At this time the only supported value isEventHubArchive.AzureBlockBlob
.
At this time it's only possible to Capture EventHub messages to Blob Storage. There's a Feature Request for the Azure SDK to add support for Capturing messages to Azure Data Lake here.
-
archive_name_format
- 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 -
blob_container_name
- (Required) The name of the Container within the Blob Storage Account where messages should be archived. -
storage_account_id
- (Required) The ID of the Blob Storage Account where messages should be archived.
» Attributes Reference
The following attributes are exported:
-
id
- The EventHub ID. -
partition_ids
- The identifiers for partitions created for Event Hubs.
» Import
EventHubs can be imported using the resource id
, e.g.
terraform import azurerm_eventhub.eventhub1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.EventHub/namespaces/namespace1/eventhubs/eventhub1