Skip to content

azurermStreamAnalyticsOutputEventhub

Manages a Stream Analytics Output to an EventHub.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const azurermResourceGroupExample = new azurerm.resourceGroup.ResourceGroup(
  this,
  "example",
  {
    location: "West Europe",
    name: "rg-example",
  }
);
const dataAzurermStreamAnalyticsJobExample =
  new azurerm.dataAzurermStreamAnalyticsJob.DataAzurermStreamAnalyticsJob(
    this,
    "example_1",
    {
      name: "example-job",
      resource_group_name: azurermResourceGroupExample.name,
    }
  );
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
dataAzurermStreamAnalyticsJobExample.overrideLogicalId("example");
const azurermEventhubNamespaceExample =
  new azurerm.eventhubNamespace.EventhubNamespace(this, "example_2", {
    capacity: 1,
    location: azurermResourceGroupExample.location,
    name: "example-ehnamespace",
    resource_group_name: azurermResourceGroupExample.name,
    sku: "Standard",
  });
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermEventhubNamespaceExample.overrideLogicalId("example");
const azurermEventhubExample = new azurerm.eventhub.Eventhub(
  this,
  "example_3",
  {
    message_retention: 1,
    name: "example-eventhub",
    namespace_name: azurermEventhubNamespaceExample.name,
    partition_count: 2,
    resource_group_name: azurermResourceGroupExample.name,
  }
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermEventhubExample.overrideLogicalId("example");
const azurermStreamAnalyticsOutputEventhubExample =
  new azurerm.streamAnalyticsOutputEventhub.StreamAnalyticsOutputEventhub(
    this,
    "example_4",
    {
      eventhub_name: azurermEventhubExample.name,
      name: "output-to-eventhub",
      resource_group_name:
        dataAzurermStreamAnalyticsJobExample.resourceGroupName,
      serialization: [
        {
          type: "Avro",
        },
      ],
      servicebus_namespace: azurermEventhubNamespaceExample.name,
      shared_access_policy_key:
        azurermEventhubNamespaceExample.defaultPrimaryKey,
      shared_access_policy_name: "RootManageSharedAccessKey",
      stream_analytics_job_name: dataAzurermStreamAnalyticsJobExample.name,
    }
  );
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermStreamAnalyticsOutputEventhubExample.overrideLogicalId("example");

Argument Reference

The following arguments are supported:

  • name - (Required) The name of the Stream Output. Changing this forces a new resource to be created.

  • resourceGroupName - (Required) The name of the Resource Group where the Stream Analytics Job exists. Changing this forces a new resource to be created.

  • streamAnalyticsJobName - (Required) The name of the Stream Analytics Job. Changing this forces a new resource to be created.

  • eventhubName - (Required) The name of the Event Hub.

  • servicebusNamespace - (Required) The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc.

  • sharedAccessPolicyKey - (Optional) The shared access policy key for the specified shared access policy. Required when authenticationMode is set to connectionString.

  • sharedAccessPolicyName - (Optional) The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required when authenticationMode is set to connectionString.

  • serialization - (Required) A serialization block as defined below.

  • propertyColumns - (Optional) A list of property columns to add to the Event Hub output.

  • authenticationMode - (Optional) The authentication mode for the Stream Output. Possible values are msi and connectionString. Defaults to connectionString.

  • partitionKey - (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 are avro, csv, json and parquet.

  • 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 to utf8.

-> NOTE: This is required when type is set to csv or json.

  • fieldDelimiter - (Optional) The delimiter that will be used to separate comma-separated value (CSV) records. Possible values are (space), `,` (comma), (tab), | (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 are array and lineSeparated.

-> NOTE: This is Required and can only be specified when type is set to json.

Attributes Reference

The following attributes are exported in addition to the arguments listed above:

  • id - The ID of the Stream Analytics Output EventHub.

Timeouts

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.

Import

Stream Analytics Outputs to an EventHub can be imported using the resourceId, 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