azurermStreamAnalyticsOutputServicebusTopic
Manages a Stream Analytics Output to a ServiceBus Topic.
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 azurermServicebusNamespaceExample =
new azurerm.servicebusNamespace.ServicebusNamespace(this, "example_1", {
location: azurermResourceGroupExample.location,
name: "example-namespace",
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.*/
azurermServicebusNamespaceExample.overrideLogicalId("example");
const azurermServicebusTopicExample =
new azurerm.servicebusTopic.ServicebusTopic(this, "example_2", {
enable_partitioning: true,
name: "example-topic",
namespace_id: azurermServicebusNamespaceExample.id,
});
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermServicebusTopicExample.overrideLogicalId("example");
const dataAzurermStreamAnalyticsJobExample =
new azurerm.dataAzurermStreamAnalyticsJob.DataAzurermStreamAnalyticsJob(
this,
"example_3",
{
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 azurermStreamAnalyticsOutputServicebusTopicExample =
new azurerm.streamAnalyticsOutputServicebusTopic.StreamAnalyticsOutputServicebusTopic(
this,
"example_4",
{
name: "service-bus-topic-output",
property_columns: ["col1", "col2"],
resource_group_name:
dataAzurermStreamAnalyticsJobExample.resourceGroupName,
serialization: [
{
format: "Array",
type: "Csv",
},
],
servicebus_namespace: azurermServicebusNamespaceExample.name,
shared_access_policy_key:
azurermServicebusNamespaceExample.defaultPrimaryKey,
shared_access_policy_name: "RootManageSharedAccessKey",
stream_analytics_job_name: dataAzurermStreamAnalyticsJobExample.name,
topic_name: azurermServicebusTopicExample.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.*/
azurermStreamAnalyticsOutputServicebusTopicExample.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. -
topicName- (Required) The name of the Service Bus Topic. -
servicebusNamespace- (Required) The namespace that is associated with the desired Event Hub, Service Bus Topic, Service Bus Topic, etc. -
sharedAccessPolicyKey- (Optional) The shared access policy key for the specified shared access policy. Required ifauthenticationModeisconnectionString. -
sharedAccessPolicyName- (Optional) The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required ifauthenticationModeisconnectionString. -
serialization- (Required) Aserializationblock as defined below. -
propertyColumns- (Optional) A list of property columns to add to the Service Bus Topic output. -
authenticationMode- (Optional) The authentication mode for the Stream Output. Possible values aremsiandconnectionString. Defaults toconnectionString. -
systemPropertyColumns- (Optional) A key-value pair of system property columns that will be attached to the outgoing messages for the Service Bus Topic Output.
-> NOTE: The acceptable keys are contentType, correlationId, label, messageId, partitionKey, replyTo, replyToSessionId, scheduledEnqueueTimeUtc, sessionId, timeToLive and to.
A serialization block supports the following:
-
type- (Required) The serialization format used for outgoing data streams. Possible values areavro,csv,jsonandparquet. -
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.
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 arearrayandlineSeparated.
-> 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 ServiceBus Topic.
Timeouts
The timeouts block allows you to specify timeouts for certain actions:
create- (Defaults to 30 minutes) Used when creating the Stream Analytics Output ServiceBus Topic.update- (Defaults to 30 minutes) Used when updating the Stream Analytics Output ServiceBus Topic.read- (Defaults to 5 minutes) Used when retrieving the Stream Analytics Output ServiceBus Topic.delete- (Defaults to 30 minutes) Used when deleting the Stream Analytics Output ServiceBus Topic.
Import
Stream Analytics Output ServiceBus Topic's can be imported using the resourceId, e.g.