subcategory | layout | page_title | description |
---|---|---|---|
Stream Analytics |
azurerm |
Azure Resource Manager: azurerm_stream_analytics_output_eventhub |
Manages a Stream Analytics Output to an EventHub. |
Manages a Stream Analytics Output to an EventHub.
data "azurerm_resource_group" "example" {
name = "example-resources"
}
data "azurerm_stream_analytics_job" "example" {
name = "example-job"
resource_group_name = azurerm_resource_group.example.name
}
resource "azurerm_eventhub_namespace" "example" {
name = "example-ehnamespace"
location = data.azurerm_resource_group.example.location
resource_group_name = data.azurerm_resource_group.example.name
sku = "Standard"
capacity = 1
}
resource "azurerm_eventhub" "example" {
name = "example-eventhub"
namespace_name = azurerm_eventhub_namespace.example.name
resource_group_name = data.azurerm_resource_group.example.name
partition_count = 2
message_retention = 1
}
resource "azurerm_stream_analytics_output_eventhub" "example" {
name = "output-to-eventhub"
stream_analytics_job_name = data.azurerm_stream_analytics_job.example.name
resource_group_name = data.azurerm_stream_analytics_job.example.resource_group_name
eventhub_name = azurerm_eventhub.example.name
servicebus_namespace = azurerm_eventhub_namespace.example.name
shared_access_policy_key = azurerm_eventhub_namespace.example.default_primary_key
shared_access_policy_name = "RootManageSharedAccessKey"
serialization {
type = "Avro"
}
}
The following arguments are supported:
-
name
- (Required) The name of the Stream Output. Changing this forces a new resource to be created. -
resource_group_name
- (Required) The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created. -
stream_analytics_job_name
- (Required) The name of the Stream Analytics Job. Changing this forces a new resource to be created. -
eventhub_name
- (Required) The name of the Event Hub. -
servicebus_namespace
- (Required) The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. -
shared_access_policy_key
- (Required) The shared access policy key for the specified shared access policy. -
shared_access_policy_name
- (Required) The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. -
serialization
- (Required) Aserialization
block as defined below. -
property_columns
- (Optional) A list of property columns to add to the Event Hub output. -
partition_key
- (Optional) The column that is used for the Event Hub partition key.
A serialization
block supports the following:
-
type
- (Required) The serialization format used for outgoing data streams. Possible values areAvro
,Csv
andJson
. -
encoding
- (Optional) The encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. It currently can only be set toUTF8
.
-> NOTE: This is required when type
is set to Csv
or Json
.
field_delimiter
- (Optional) The delimiter that will be used to separate comma-separated value (CSV) records. Possible values are,
(comma),|
(pipe) and;
.
-> NOTE: This is required when type
is set to Csv
.
format
- (Optional) Specifies the format of the JSON the output will be written in. Possible values areArray
andLineSeparated
.
-> NOTE: This is Required and can only be specified when type
is set to Json
.
The following attributes are exported in addition to the arguments listed above:
id
- The ID of the Stream Analytics Output EventHub.
The timeouts
block allows you to specify timeouts for certain actions:
create
- (Defaults to 30 minutes) Used when creating the Stream Analytics Output EventHub.update
- (Defaults to 30 minutes) Used when updating the Stream Analytics Output EventHub.read
- (Defaults to 5 minutes) Used when retrieving the Stream Analytics Output EventHub.delete
- (Defaults to 30 minutes) Used when deleting the Stream Analytics Output EventHub.
Stream Analytics Outputs to an EventHub can be imported using the resource id
, e.g.
terraform import azurerm_stream_analytics_output_eventhub.example /subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/group1/providers/Microsoft.StreamAnalytics/streamingjobs/job1/outputs/output1