Share via

Microsoft.TimeSeriesInsights environments/referenceDataSets 2017-02-28-preview

Bicep resource definition

The environments/referenceDataSets resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.TimeSeriesInsights/environments/referenceDataSets resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.TimeSeriesInsights/environments/referenceDataSets@2017-02-28-preview' = {
  parent: resourceSymbolicName
  ___location: 'string'
  name: 'string'
  properties: {
    keyProperties: [
      {
        name: 'string'
        type: 'string'
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.TimeSeriesInsights/environments/referenceDataSets

Name Description Value
___location The ___location of the resource. string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[A-Za-z0-9] (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: environments
properties Properties used to create a reference data set. ReferenceDataSetCreationPropertiesOrReferenceDataSetResourceProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates

CreateOrUpdateTrackedResourcePropertiesTags

Name Description Value

ReferenceDataSetCreationPropertiesOrReferenceDataSetResourceProperties

Name Description Value
keyProperties The list of key properties for the reference data set. ReferenceDataSetKeyProperty[] (required)

ReferenceDataSetKeyProperty

Name Description Value
name The name of the key property. string
type The type of the key property. 'Bool'
'DateTime'
'Double'
'String'

ARM template resource definition

The environments/referenceDataSets resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.TimeSeriesInsights/environments/referenceDataSets resource, add the following JSON to your template.

{
  "type": "Microsoft.TimeSeriesInsights/environments/referenceDataSets",
  "apiVersion": "2017-02-28-preview",
  "name": "string",
  "___location": "string",
  "properties": {
    "keyProperties": [
      {
        "name": "string",
        "type": "string"
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.TimeSeriesInsights/environments/referenceDataSets

Name Description Value
apiVersion The api version '2017-02-28-preview'
___location The ___location of the resource. string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[A-Za-z0-9] (required)
properties Properties used to create a reference data set. ReferenceDataSetCreationPropertiesOrReferenceDataSetResourceProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.TimeSeriesInsights/environments/referenceDataSets'

CreateOrUpdateTrackedResourcePropertiesTags

Name Description Value

ReferenceDataSetCreationPropertiesOrReferenceDataSetResourceProperties

Name Description Value
keyProperties The list of key properties for the reference data set. ReferenceDataSetKeyProperty[] (required)

ReferenceDataSetKeyProperty

Name Description Value
name The name of the key property. string
type The type of the key property. 'Bool'
'DateTime'
'Double'
'String'

Usage Examples

Terraform (AzAPI provider) resource definition

The environments/referenceDataSets resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.TimeSeriesInsights/environments/referenceDataSets resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.TimeSeriesInsights/environments/referenceDataSets@2017-02-28-preview"
  name = "string"
  parent_id = "string"
  ___location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      keyProperties = [
        {
          name = "string"
          type = "string"
        }
      ]
    }
  }
}

Property Values

Microsoft.TimeSeriesInsights/environments/referenceDataSets

Name Description Value
___location The ___location of the resource. string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[A-Za-z0-9] (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: environments
properties Properties used to create a reference data set. ReferenceDataSetCreationPropertiesOrReferenceDataSetResourceProperties (required)
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.TimeSeriesInsights/environments/referenceDataSets@2017-02-28-preview"

CreateOrUpdateTrackedResourcePropertiesTags

Name Description Value

ReferenceDataSetCreationPropertiesOrReferenceDataSetResourceProperties

Name Description Value
keyProperties The list of key properties for the reference data set. ReferenceDataSetKeyProperty[] (required)

ReferenceDataSetKeyProperty

Name Description Value
name The name of the key property. string
type The type of the key property. 'Bool'
'DateTime'
'Double'
'String'

Usage Examples

Terraform Samples

A basic example of deploying Time Series Insights Environments Reference Data Sets.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "___location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  ___location = var.___location
}

resource "azapi_resource" "environment" {
  type      = "Microsoft.TimeSeriesInsights/environments@2020-05-15"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  ___location  = var.___location
  body = {
    kind = "Gen1"
    properties = {
      dataRetentionTime            = "P30D"
      storageLimitExceededBehavior = "PurgeOldData"
    }
    sku = {
      capacity = 1
      name     = "S1"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "referenceDataSet" {
  type      = "Microsoft.TimeSeriesInsights/environments/referenceDataSets@2020-05-15"
  parent_id = azapi_resource.environment.id
  name      = var.resource_name
  ___location  = var.___location
  body = {
    properties = {
      dataStringComparisonBehavior = "Ordinal"
      keyProperties = [
        {
          name = "keyProperty1"
          type = "String"
        },
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}
  • Last updated on