Skip to content

Commit

Permalink
Added documentation covering the CaptureDescription fields
Browse files Browse the repository at this point in the history
Also added a link to the feature request for Data Lake Capture support
  • Loading branch information
tombuildsstuff committed Jan 11, 2018
1 parent b83b3ad commit 9cba8ef
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 3 deletions.
2 changes: 1 addition & 1 deletion azurerm/resource_arm_eventhub.go
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ func resourceArmEventHub() *schema.Resource {
ValidateFunc: validation.StringInSlice([]string{
"EventHubArchive.AzureBlockBlob",
// TODO: support `EventHubArchive.AzureDataLake` once supported in the Swagger / SDK
// TODO: file a Swagger bug about that.
// https://github.com/Azure/azure-rest-api-specs/issues/2255
// BlobContainerName & StorageAccountID can then become Optional
}, false),
},
Expand Down
32 changes: 30 additions & 2 deletions website/docs/r/eventhub.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: |-
Creates a new Event Hubs as a nested resource within an Event Hubs namespace.
---

# azurerm\_eventhub
# azurerm_eventhub

Creates a new Event Hubs as a nested resource within a Event Hubs namespace.

Expand All @@ -20,7 +20,7 @@ resource "azurerm_resource_group" "test" {
resource "azurerm_eventhub_namespace" "test" {
name = "acceptanceTestEventHubNamespace"
location = "West US"
location = "${azurerm_resource_group.test.location}"
resource_group_name = "${azurerm_resource_group.test.name}"
sku = "Standard"
capacity = 1
Expand Down Expand Up @@ -53,6 +53,34 @@ The following arguments are supported:

* `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) A `capture_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 are `Avro` and `AvroDeflate`.

* `interval_in_seconds` - (Optional) Specifies the time interval in seconds at which the capture will happen. Values can be between `60` and `900` seconds. Defaults to `300` seconds.

* `size_limit_in_bytes` - (Optional) Specifies the 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.

* `destination` - (Required) A `destination` 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 is `EventHubArchive.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](https://github.com/Azure/azure-rest-api-specs/issues/2255).

* `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:
Expand Down

0 comments on commit 9cba8ef

Please sign in to comment.