reference_data_sets

Creates, updates, deletes, gets or lists a reference_data_sets resource.

Overview

Name	reference_data_sets
Type	Resource
Id	azure.time_series_insights.reference_data_sets

Fields

The following fields are returned by SELECT queries:

get

The reference data set definition was successfully retrieved and is in the response.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of the reference data set.
tags	object	Resource tags.

list_by_environment

Reference data sets returned successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of the reference data set.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, environmentName, referenceDataSetName		Gets the reference data set with the specified name in the specified environment.
list_by_environment	select	subscriptionId, resourceGroupName, environmentName		Lists all the available reference data sets associated with the subscription and within the specified resource group and environment.
create_or_update	insert	subscriptionId, resourceGroupName, environmentName, referenceDataSetName, data__properties		Create or update a reference data set in the specified environment.
update	update	subscriptionId, resourceGroupName, environmentName, referenceDataSetName		Updates the reference data set with the specified name in the specified subscription, resource group, and environment.
delete	delete	subscriptionId, resourceGroupName, environmentName, referenceDataSetName		Deletes the reference data set with the specified name in the specified subscription, resource group, and environment

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
environmentName	string	The name of the Time Series Insights environment associated with the specified resource group.
referenceDataSetName	string	The name of the Time Series Insights reference data set associated with the specified environment.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets the reference data set with the specified name in the specified environment.

SELECT
location,
properties,
tags
FROM azure.time_series_insights.reference_data_sets
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND environmentName = '{{ environmentName }}' -- required
AND referenceDataSetName = '{{ referenceDataSetName }}' -- required
;

list_by_environment

Lists all the available reference data sets associated with the subscription and within the specified resource group and environment.

SELECT
location,
properties,
tags
FROM azure.time_series_insights.reference_data_sets
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND environmentName = '{{ environmentName }}' -- required
;

INSERT examples

create_or_update

Create or update a reference data set in the specified environment.

INSERT INTO azure.time_series_insights.reference_data_sets (
data__properties,
data__location,
data__tags,
subscriptionId,
resourceGroupName,
environmentName,
referenceDataSetName
)
SELECT 
'{{ properties }}' /* required */,
'{{ location }}',
'{{ tags }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ environmentName }}',
'{{ referenceDataSetName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: reference_data_sets
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the reference_data_sets resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the reference_data_sets resource.
    - name: environmentName
      value: string
      description: Required parameter for the reference_data_sets resource.
    - name: referenceDataSetName
      value: string
      description: Required parameter for the reference_data_sets resource.
    - name: properties
      value: object
      description: |
        Properties used to create a reference data set.
    - name: location
      value: string
      description: |
        The location of the resource.
    - name: tags
      value: object
      description: |
        Key-value pairs of additional properties for the resource.

UPDATE examples

update

Updates the reference data set with the specified name in the specified subscription, resource group, and environment.

UPDATE azure.time_series_insights.reference_data_sets
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND environmentName = '{{ environmentName }}' --required
AND referenceDataSetName = '{{ referenceDataSetName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Deletes the reference data set with the specified name in the specified subscription, resource group, and environment

DELETE FROM azure.time_series_insights.reference_data_sets
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND environmentName = '{{ environmentName }}' --required
AND referenceDataSetName = '{{ referenceDataSetName }}' --required
;