Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. timeseriesinsights
  5. ReferenceDataSet
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.timeseriesinsights.ReferenceDataSet

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    A reference data set provides metadata about the events in an environment. Metadata in the reference data set will be joined with events as they are read from event sources. The metadata that makes up the reference data set is uploaded or modified through the Time Series Insights data plane APIs. Azure REST API version: 2020-05-15. Prior API version in Azure Native 1.x: 2020-05-15.

    Other available API versions: 2021-06-30-preview.

    Example Usage

    ReferenceDataSetsCreate

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var referenceDataSet = new AzureNative.TimeSeriesInsights.ReferenceDataSet("referenceDataSet", new()
    {
        EnvironmentName = "env1",
        KeyProperties = new[]
        {
            new AzureNative.TimeSeriesInsights.Inputs.ReferenceDataSetKeyPropertyArgs
            {
                Name = "DeviceId1",
                Type = AzureNative.TimeSeriesInsights.ReferenceDataKeyPropertyType.String,
            },
            new AzureNative.TimeSeriesInsights.Inputs.ReferenceDataSetKeyPropertyArgs
            {
                Name = "DeviceFloor",
                Type = AzureNative.TimeSeriesInsights.ReferenceDataKeyPropertyType.Double,
            },
        },
        Location = "West US",
        ReferenceDataSetName = "rds1",
        ResourceGroupName = "rg1",
    });

});

    package main

import (
	timeseriesinsights "github.com/pulumi/pulumi-azure-native-sdk/timeseriesinsights/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := timeseriesinsights.NewReferenceDataSet(ctx, "referenceDataSet", &timeseriesinsights.ReferenceDataSetArgs{
			EnvironmentName: pulumi.String("env1"),
			KeyProperties: timeseriesinsights.ReferenceDataSetKeyPropertyArray{
				&timeseriesinsights.ReferenceDataSetKeyPropertyArgs{
					Name: pulumi.String("DeviceId1"),
					Type: pulumi.String(timeseriesinsights.ReferenceDataKeyPropertyTypeString),
				},
				&timeseriesinsights.ReferenceDataSetKeyPropertyArgs{
					Name: pulumi.String("DeviceFloor"),
					Type: pulumi.String(timeseriesinsights.ReferenceDataKeyPropertyTypeDouble),
				},
			},
			Location:             pulumi.String("West US"),
			ReferenceDataSetName: pulumi.String("rds1"),
			ResourceGroupName:    pulumi.String("rg1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.timeseriesinsights.ReferenceDataSet;
import com.pulumi.azurenative.timeseriesinsights.ReferenceDataSetArgs;
import com.pulumi.azurenative.timeseriesinsights.inputs.ReferenceDataSetKeyPropertyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var referenceDataSet = new ReferenceDataSet("referenceDataSet", ReferenceDataSetArgs.builder()
            .environmentName("env1")
            .keyProperties(            
                ReferenceDataSetKeyPropertyArgs.builder()
                    .name("DeviceId1")
                    .type("String")
                    .build(),
                ReferenceDataSetKeyPropertyArgs.builder()
                    .name("DeviceFloor")
                    .type("Double")
                    .build())
            .location("West US")
            .referenceDataSetName("rds1")
            .resourceGroupName("rg1")
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const referenceDataSet = new azure_native.timeseriesinsights.ReferenceDataSet("referenceDataSet", {
    environmentName: "env1",
    keyProperties: [
        {
            name: "DeviceId1",
            type: azure_native.timeseriesinsights.ReferenceDataKeyPropertyType.String,
        },
        {
            name: "DeviceFloor",
            type: azure_native.timeseriesinsights.ReferenceDataKeyPropertyType.Double,
        },
    ],
    location: "West US",
    referenceDataSetName: "rds1",
    resourceGroupName: "rg1",
});

    import pulumi
import pulumi_azure_native as azure_native

reference_data_set = azure_native.timeseriesinsights.ReferenceDataSet("referenceDataSet",
    environment_name="env1",
    key_properties=[
        {
            "name": "DeviceId1",
            "type": azure_native.timeseriesinsights.ReferenceDataKeyPropertyType.STRING,
        },
        {
            "name": "DeviceFloor",
            "type": azure_native.timeseriesinsights.ReferenceDataKeyPropertyType.DOUBLE,
        },
    ],
    location="West US",
    reference_data_set_name="rds1",
    resource_group_name="rg1")

    resources:
  referenceDataSet:
    type: azure-native:timeseriesinsights:ReferenceDataSet
    properties:
      environmentName: env1
      keyProperties:
        - name: DeviceId1
          type: String
        - name: DeviceFloor
          type: Double
      location: West US
      referenceDataSetName: rds1
      resourceGroupName: rg1

    Create ReferenceDataSet Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ReferenceDataSet(name: string, args: ReferenceDataSetArgs, opts?: CustomResourceOptions);
    @overload
def ReferenceDataSet(resource_name: str,
                     args: ReferenceDataSetArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def ReferenceDataSet(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     environment_name: Optional[str] = None,
                     key_properties: Optional[Sequence[ReferenceDataSetKeyPropertyArgs]] = None,
                     resource_group_name: Optional[str] = None,
                     data_string_comparison_behavior: Optional[Union[str, DataStringComparisonBehavior]] = None,
                     location: Optional[str] = None,
                     reference_data_set_name: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None)
    func NewReferenceDataSet(ctx *Context, name string, args ReferenceDataSetArgs, opts ...ResourceOption) (*ReferenceDataSet, error)
    public ReferenceDataSet(string name, ReferenceDataSetArgs args, CustomResourceOptions? opts = null)
    public ReferenceDataSet(String name, ReferenceDataSetArgs args)
public ReferenceDataSet(String name, ReferenceDataSetArgs args, CustomResourceOptions options)

    type: azure-native:timeseriesinsights:ReferenceDataSet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ReferenceDataSetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ReferenceDataSetArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ReferenceDataSetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ReferenceDataSetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ReferenceDataSetArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var referenceDataSetResource = new AzureNative.TimeSeriesInsights.ReferenceDataSet("referenceDataSetResource", new()
{
    EnvironmentName = "string",
    KeyProperties = new[]
    {
        new AzureNative.TimeSeriesInsights.Inputs.ReferenceDataSetKeyPropertyArgs
        {
            Name = "string",
            Type = "string",
        },
    },
    ResourceGroupName = "string",
    DataStringComparisonBehavior = "string",
    Location = "string",
    ReferenceDataSetName = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := timeseriesinsights.NewReferenceDataSet(ctx, "referenceDataSetResource", &timeseriesinsights.ReferenceDataSetArgs{
	EnvironmentName: pulumi.String("string"),
	KeyProperties: timeseriesinsights.ReferenceDataSetKeyPropertyArray{
		&timeseriesinsights.ReferenceDataSetKeyPropertyArgs{
			Name: pulumi.String("string"),
			Type: pulumi.String("string"),
		},
	},
	ResourceGroupName:            pulumi.String("string"),
	DataStringComparisonBehavior: pulumi.String("string"),
	Location:                     pulumi.String("string"),
	ReferenceDataSetName:         pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var referenceDataSetResource = new ReferenceDataSet("referenceDataSetResource", ReferenceDataSetArgs.builder()
    .environmentName("string")
    .keyProperties(ReferenceDataSetKeyPropertyArgs.builder()
        .name("string")
        .type("string")
        .build())
    .resourceGroupName("string")
    .dataStringComparisonBehavior("string")
    .location("string")
    .referenceDataSetName("string")
    .tags(Map.of("string", "string"))
    .build());

    reference_data_set_resource = azure_native.timeseriesinsights.ReferenceDataSet("referenceDataSetResource",
    environment_name="string",
    key_properties=[{
        "name": "string",
        "type": "string",
    }],
    resource_group_name="string",
    data_string_comparison_behavior="string",
    location="string",
    reference_data_set_name="string",
    tags={
        "string": "string",
    })

    const referenceDataSetResource = new azure_native.timeseriesinsights.ReferenceDataSet("referenceDataSetResource", {
    environmentName: "string",
    keyProperties: [{
        name: "string",
        type: "string",
    }],
    resourceGroupName: "string",
    dataStringComparisonBehavior: "string",
    location: "string",
    referenceDataSetName: "string",
    tags: {
        string: "string",
    },
});

    type: azure-native:timeseriesinsights:ReferenceDataSet
properties:
    dataStringComparisonBehavior: string
    environmentName: string
    keyProperties:
        - name: string
          type: string
    location: string
    referenceDataSetName: string
    resourceGroupName: string
    tags:
        string: string

    ReferenceDataSet Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ReferenceDataSet resource accepts the following input properties:

    EnvironmentName string
    The name of the Time Series Insights environment associated with the specified resource group.
    KeyProperties List<Pulumi.AzureNative.TimeSeriesInsights.Inputs.ReferenceDataSetKeyProperty>
    The list of key properties for the reference data set.
    ResourceGroupName string
    Name of an Azure Resource group.
    DataStringComparisonBehavior string | Pulumi.AzureNative.TimeSeriesInsights.DataStringComparisonBehavior
    The reference data set key comparison behavior can be set using this property. By default, the value is 'Ordinal' - which means case sensitive key comparison will be performed while joining reference data with events or while adding new reference data. When 'OrdinalIgnoreCase' is set, case insensitive comparison will be used.
    Location string
    The location of the resource.
    ReferenceDataSetName string
    Name of the reference data set.
    Tags Dictionary<string, string>
    Key-value pairs of additional properties for the resource.
    EnvironmentName string
    The name of the Time Series Insights environment associated with the specified resource group.
    KeyProperties []ReferenceDataSetKeyPropertyArgs
    The list of key properties for the reference data set.
    ResourceGroupName string
    Name of an Azure Resource group.
    DataStringComparisonBehavior string | DataStringComparisonBehavior
    The reference data set key comparison behavior can be set using this property. By default, the value is 'Ordinal' - which means case sensitive key comparison will be performed while joining reference data with events or while adding new reference data. When 'OrdinalIgnoreCase' is set, case insensitive comparison will be used.
    Location string
    The location of the resource.
    ReferenceDataSetName string
    Name of the reference data set.
    Tags map[string]string
    Key-value pairs of additional properties for the resource.
    environmentName String
    The name of the Time Series Insights environment associated with the specified resource group.
    keyProperties List<ReferenceDataSetKeyProperty>
    The list of key properties for the reference data set.
    resourceGroupName String
    Name of an Azure Resource group.
    dataStringComparisonBehavior String | DataStringComparisonBehavior
    The reference data set key comparison behavior can be set using this property. By default, the value is 'Ordinal' - which means case sensitive key comparison will be performed while joining reference data with events or while adding new reference data. When 'OrdinalIgnoreCase' is set, case insensitive comparison will be used.
    location String
    The location of the resource.
    referenceDataSetName String
    Name of the reference data set.
    tags Map<String,String>
    Key-value pairs of additional properties for the resource.
    environmentName string
    The name of the Time Series Insights environment associated with the specified resource group.
    keyProperties ReferenceDataSetKeyProperty[]
    The list of key properties for the reference data set.
    resourceGroupName string
    Name of an Azure Resource group.
    dataStringComparisonBehavior string | DataStringComparisonBehavior
    The reference data set key comparison behavior can be set using this property. By default, the value is 'Ordinal' - which means case sensitive key comparison will be performed while joining reference data with events or while adding new reference data. When 'OrdinalIgnoreCase' is set, case insensitive comparison will be used.
    location string
    The location of the resource.
    referenceDataSetName string
    Name of the reference data set.
    tags {[key: string]: string}
    Key-value pairs of additional properties for the resource.
    environment_name str
    The name of the Time Series Insights environment associated with the specified resource group.
    key_properties Sequence[ReferenceDataSetKeyPropertyArgs]
    The list of key properties for the reference data set.
    resource_group_name str
    Name of an Azure Resource group.
    data_string_comparison_behavior str | DataStringComparisonBehavior
    The reference data set key comparison behavior can be set using this property. By default, the value is 'Ordinal' - which means case sensitive key comparison will be performed while joining reference data with events or while adding new reference data. When 'OrdinalIgnoreCase' is set, case insensitive comparison will be used.
    location str
    The location of the resource.
    reference_data_set_name str
    Name of the reference data set.
    tags Mapping[str, str]
    Key-value pairs of additional properties for the resource.
    environmentName String
    The name of the Time Series Insights environment associated with the specified resource group.
    keyProperties List<Property Map>
    The list of key properties for the reference data set.
    resourceGroupName String
    Name of an Azure Resource group.
    dataStringComparisonBehavior String | "Ordinal" | "OrdinalIgnoreCase"
    The reference data set key comparison behavior can be set using this property. By default, the value is 'Ordinal' - which means case sensitive key comparison will be performed while joining reference data with events or while adding new reference data. When 'OrdinalIgnoreCase' is set, case insensitive comparison will be used.
    location String
    The location of the resource.
    referenceDataSetName String
    Name of the reference data set.
    tags Map<String>
    Key-value pairs of additional properties for the resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ReferenceDataSet resource produces the following output properties:

    CreationTime string
    The time the resource was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name
    ProvisioningState string
    Provisioning state of the resource.
    Type string
    Resource type
    CreationTime string
    The time the resource was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name
    ProvisioningState string
    Provisioning state of the resource.
    Type string
    Resource type
    creationTime String
    The time the resource was created.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name
    provisioningState String
    Provisioning state of the resource.
    type String
    Resource type
    creationTime string
    The time the resource was created.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Resource name
    provisioningState string
    Provisioning state of the resource.
    type string
    Resource type
    creation_time str
    The time the resource was created.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Resource name
    provisioning_state str
    Provisioning state of the resource.
    type str
    Resource type
    creationTime String
    The time the resource was created.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name
    provisioningState String
    Provisioning state of the resource.
    type String
    Resource type

    Supporting Types

    DataStringComparisonBehavior, DataStringComparisonBehaviorArgs

    Ordinal
    Ordinal
    OrdinalIgnoreCase
    OrdinalIgnoreCase
    DataStringComparisonBehaviorOrdinal
    Ordinal
    DataStringComparisonBehaviorOrdinalIgnoreCase
    OrdinalIgnoreCase
    Ordinal
    Ordinal
    OrdinalIgnoreCase
    OrdinalIgnoreCase
    Ordinal
    Ordinal
    OrdinalIgnoreCase
    OrdinalIgnoreCase
    ORDINAL
    Ordinal
    ORDINAL_IGNORE_CASE
    OrdinalIgnoreCase
    "Ordinal"
    Ordinal
    "OrdinalIgnoreCase"
    OrdinalIgnoreCase

    ReferenceDataKeyPropertyType, ReferenceDataKeyPropertyTypeArgs

    String
    String
    Double
    Double
    Bool
    Bool
    DateTime
    DateTime
    ReferenceDataKeyPropertyTypeString
    String
    ReferenceDataKeyPropertyTypeDouble
    Double
    ReferenceDataKeyPropertyTypeBool
    Bool
    ReferenceDataKeyPropertyTypeDateTime
    DateTime
    String
    String
    Double
    Double
    Bool
    Bool
    DateTime
    DateTime
    String
    String
    Double
    Double
    Bool
    Bool
    DateTime
    DateTime
    STRING
    String
    DOUBLE
    Double
    BOOL
    Bool
    DATE_TIME
    DateTime
    "String"
    String
    "Double"
    Double
    "Bool"
    Bool
    "DateTime"
    DateTime

    ReferenceDataSetKeyProperty, ReferenceDataSetKeyPropertyArgs

    Name string
    The name of the key property.
    Type string | Pulumi.AzureNative.TimeSeriesInsights.ReferenceDataKeyPropertyType
    The type of the key property.
    Name string
    The name of the key property.
    Type string | ReferenceDataKeyPropertyType
    The type of the key property.
    name String
    The name of the key property.
    type String | ReferenceDataKeyPropertyType
    The type of the key property.
    name string
    The name of the key property.
    type string | ReferenceDataKeyPropertyType
    The type of the key property.
    name str
    The name of the key property.
    type str | ReferenceDataKeyPropertyType
    The type of the key property.
    name String
    The name of the key property.
    type String | "String" | "Double" | "Bool" | "DateTime"
    The type of the key property.

    ReferenceDataSetKeyPropertyResponse, ReferenceDataSetKeyPropertyResponseArgs

    Name string
    The name of the key property.
    Type string
    The type of the key property.
    Name string
    The name of the key property.
    Type string
    The type of the key property.
    name String
    The name of the key property.
    type String
    The type of the key property.
    name string
    The name of the key property.
    type string
    The type of the key property.
    name str
    The name of the key property.
    type str
    The type of the key property.
    name String
    The name of the key property.
    type String
    The type of the key property.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:timeseriesinsights:ReferenceDataSet rds1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/referenceDataSets/{referenceDataSetName}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native