reference_data_sets

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

Overview

Name	reference_data_sets
Type	Resource
Id	azure_extras.time_series_insights.reference_data_sets

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
creationTime	string (date-time)	The time the resource was created.
dataStringComparisonBehavior	string	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. Known values are: "Ordinal" and "OrdinalIgnoreCase".
keyProperties	array	The list of key properties for the reference data set.
location	string	Resource location. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Creating", "Updating", "Succeeded", "Failed", and "Deleting".
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_environment

Name	Datatype	Description
value	array	Result of the List Reference Data Sets operation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, environment_name, reference_data_set_name, subscription_id		Gets the reference data set with the specified name in the specified environment.
list_by_environment	select	resource_group_name, environment_name, subscription_id		Lists all the available reference data sets associated with the subscription and within the specified resource group and environment.
create_or_update	insert	resource_group_name, environment_name, reference_data_set_name, subscription_id, location, properties		Create or update a reference data set in the specified environment.
update	update	resource_group_name, environment_name, reference_data_set_name, subscription_id		Updates the reference data set with the specified name in the specified subscription, resource group, and environment.
create_or_update	replace	resource_group_name, environment_name, reference_data_set_name, subscription_id, location, properties		Create or update a reference data set in the specified environment.
delete	delete	resource_group_name, environment_name, reference_data_set_name, subscription_id		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
environment_name	string	The name of the Time Series Insights environment associated with the specified resource group. Required.
reference_data_set_name	string	The name of the Time Series Insights reference data set associated with the specified environment. Required.
resource_group_name	string	Name of an Azure Resource group. Required.
subscription_id	string

SELECT examples

get

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

SELECT
id,
name,
creationTime,
dataStringComparisonBehavior,
keyProperties,
location,
provisioningState,
tags,
type
FROM azure_extras.time_series_insights.reference_data_sets
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND environment_name = '{{ environment_name }}' -- required
AND reference_data_set_name = '{{ reference_data_set_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_environment

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

SELECT
value
FROM azure_extras.time_series_insights.reference_data_sets
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND environment_name = '{{ environment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure_extras.time_series_insights.reference_data_sets (
location,
tags,
properties,
resource_group_name,
environment_name,
reference_data_set_name,
subscription_id
)
SELECT 
'{{ location }}' /* required */,
'{{ tags }}',
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ environment_name }}',
'{{ reference_data_set_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: reference_data_sets
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the reference_data_sets resource.
  - name: environment_name
    value: "{{ environment_name }}"
    description: Required parameter for the reference_data_sets resource.
  - name: reference_data_set_name
    value: "{{ reference_data_set_name }}"
    description: Required parameter for the reference_data_sets resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the reference_data_sets resource.
  - name: location
    value: "{{ location }}"
    description: |
      The location of the resource. Required.
  - name: tags
    value: "{{ tags }}"
    description: |
      Key-value pairs of additional properties for the resource.
  - name: properties
    value:
      keyProperties:
        - name: "{{ name }}"
          type: "{{ type }}"
      dataStringComparisonBehavior: "{{ dataStringComparisonBehavior }}"

UPDATE examples

update

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

UPDATE azure_extras.time_series_insights.reference_data_sets
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND environment_name = '{{ environment_name }}' --required
AND reference_data_set_name = '{{ reference_data_set_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

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

REPLACE azure_extras.time_series_insights.reference_data_sets
SET 
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND environment_name = '{{ environment_name }}' --required
AND reference_data_set_name = '{{ reference_data_set_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

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

DELETE FROM azure_extras.time_series_insights.reference_data_sets
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND environment_name = '{{ environment_name }}' --required
AND reference_data_set_name = '{{ reference_data_set_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;