Skip to content

azurermIotTimeSeriesInsightsReferenceDataSet

Manages an Azure IoT Time Series Insights Reference Data Set.

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: "example-resources",
  }
);
const azurermIotTimeSeriesInsightsStandardEnvironmentExample =
  new azurerm.iotTimeSeriesInsightsStandardEnvironment.IotTimeSeriesInsightsStandardEnvironment(
    this,
    "example_1",
    {
      data_retention_time: "P30D",
      location: azurermResourceGroupExample.location,
      name: "example",
      resource_group_name: azurermResourceGroupExample.name,
      sku_name: "S1_1",
    }
  );
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermIotTimeSeriesInsightsStandardEnvironmentExample.overrideLogicalId(
  "example"
);
const azurermIotTimeSeriesInsightsReferenceDataSetExample =
  new azurerm.iotTimeSeriesInsightsReferenceDataSet.IotTimeSeriesInsightsReferenceDataSet(
    this,
    "example_2",
    {
      key_property: [
        {
          name: "keyProperty1",
          type: "String",
        },
      ],
      location: azurermResourceGroupExample.location,
      name: "example",
      time_series_insights_environment_id:
        azurermIotTimeSeriesInsightsStandardEnvironmentExample.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.*/
azurermIotTimeSeriesInsightsReferenceDataSetExample.overrideLogicalId(
  "example"
);

Argument Reference

The following arguments are supported:

  • name - (Required) Specifies the name of the Azure IoT Time Series Insights Reference Data Set. Changing this forces a new resource to be created. Must be globally unique.

  • timeSeriesInsightsEnvironmentId - (Required) The resource ID of the Azure IoT Time Series Insights Environment in which to create the Azure IoT Time Series Insights Reference Data Set. Changing this forces a new resource to be created.

  • location - (Required) Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • dataStringComparisonBehavior - (Optional) The comparison behavior that will be used to compare keys. Valid values include ordinal and ordinalIgnoreCase. Defaults to ordinal. Changing this forces a new resource to be created.

  • keyProperty - (Required) A keyProperty block as defined below. Changing this forces a new resource to be created.

  • tags - (Optional) A mapping of tags to assign to the resource.


A keyProperty block supports the following:

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

  • type - (Required) The data type of the key property. Valid values include bool, dateTime, double, string. Changing this forces a new resource to be created.

Attributes Reference

The following attributes are exported:

  • id - The ID of the IoT Time Series Insights Reference Data Set.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • create - (Defaults to 30 minutes) Used when creating the IoT Time Series Insights Reference Data Set.
  • update - (Defaults to 30 minutes) Used when updating the IoT Time Series Insights Reference Data Set.
  • read - (Defaults to 5 minutes) Used when retrieving the IoT Time Series Insights Reference Data Set.
  • delete - (Defaults to 30 minutes) Used when deleting the IoT Time Series Insights Reference Data Set.

Import

Azure IoT Time Series Insights Reference Data Set can be imported using the resourceId, e.g.

terraform import azurerm_iot_time_series_insights_reference_data_set.example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.TimeSeriesInsights/environments/example/referenceDataSets/example