time_series_database_connections

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

Overview

Name	time_series_database_connections
Type	Resource
Id	azure.digital_twins.time_series_database_connections

Fields

The following fields are returned by SELECT queries:

get

Description of the time series connection.

Name	Datatype	Description
id	string	The resource identifier.
name	string	Extension resource name. (pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$)
properties	object	Properties of a specific time series database connection.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The resource type.

list

List of time series database connections for this DigitalTwins instance.

Name	Datatype	Description
id	string	The resource identifier.
name	string	Extension resource name. (pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$)
properties	object	Properties of a specific time series database connection.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, resourceName, timeSeriesDatabaseConnectionName	api-version	Get the description of an existing time series database connection.
list	select	subscriptionId, resourceGroupName, resourceName	api-version	Get all existing time series database connections for this DigitalTwins instance.
create_or_update	insert	subscriptionId, resourceGroupName, resourceName, timeSeriesDatabaseConnectionName	api-version	Create or update a time series database connection.
delete	delete	subscriptionId, resourceGroupName, resourceName, timeSeriesDatabaseConnectionName	api-version, cleanupConnectionArtifacts	Delete a time series database connection.

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
resourceGroupName	string	The name of the resource group that contains the DigitalTwinsInstance.
resourceName	string	The name of the DigitalTwinsInstance.
subscriptionId	string	The subscription identifier.
timeSeriesDatabaseConnectionName	string	Name of time series database connection.
api-version	string	Version of the DigitalTwinsInstance Management API.
cleanupConnectionArtifacts	string	Specifies whether or not to attempt to clean up artifacts that were created in order to establish a connection to the time series database. This is a best-effort attempt that will fail if appropriate permissions are not in place. Setting this to 'true' does not delete any recorded data.

SELECT examples

get

Get the description of an existing time series database connection.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.digital_twins.time_series_database_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND timeSeriesDatabaseConnectionName = '{{ timeSeriesDatabaseConnectionName }}' -- required
AND api-version = '{{ api-version }}'
;

list

Get all existing time series database connections for this DigitalTwins instance.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.digital_twins.time_series_database_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create_or_update

Create or update a time series database connection.

INSERT INTO azure.digital_twins.time_series_database_connections (
data__properties,
subscriptionId,
resourceGroupName,
resourceName,
timeSeriesDatabaseConnectionName,
api-version
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ timeSeriesDatabaseConnectionName }}',
'{{ api-version }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: time_series_database_connections
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the time_series_database_connections resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the time_series_database_connections resource.
    - name: resourceName
      value: string
      description: Required parameter for the time_series_database_connections resource.
    - name: timeSeriesDatabaseConnectionName
      value: string
      description: Required parameter for the time_series_database_connections resource.
    - name: properties
      value: object
      description: |
        Properties of a specific time series database connection.
    - name: api-version
      value: string
      description: Version of the DigitalTwinsInstance Management API.

DELETE examples

delete

Delete a time series database connection.

DELETE FROM azure.digital_twins.time_series_database_connections
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
AND timeSeriesDatabaseConnectionName = '{{ timeSeriesDatabaseConnectionName }}' --required
AND api-version = '{{ api-version }}'
AND cleanupConnectionArtifacts = '{{ cleanupConnectionArtifacts }}'
;