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

Name	Datatype	Description
id	string	The resource identifier.
name	string	Extension resource name.
connectionType	string	The type of time series connection resource. Required. "AzureDataExplorer"
identity	object	Managed identity properties for the time series database connection resource.
provisioningState	string	The provisioning state. Known values are: "Provisioning", "Deleting", "Updating", "Succeeded", "Failed", "Canceled", "Deleted", "Warning", "Suspending", "Restoring", "Moving", and "Disabled".
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The resource type.

list

Name	Datatype	Description
id	string	The resource identifier.
name	string	Extension resource name.
connectionType	string	The type of time series connection resource. Required. "AzureDataExplorer"
identity	object	Managed identity properties for the time series database connection resource.
provisioningState	string	The provisioning state. Known values are: "Provisioning", "Deleting", "Updating", "Succeeded", "Failed", "Canceled", "Deleted", "Warning", "Suspending", "Restoring", "Moving", and "Disabled".
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	resource_group_name, resource_name, time_series_database_connection_name, subscription_id		Get the description of an existing time series database connection.
list	select	resource_group_name, resource_name, subscription_id		Get all existing time series database connections for this DigitalTwins instance.
create_or_update	insert	resource_group_name, resource_name, time_series_database_connection_name, subscription_id		Create or update a time series database connection.
create_or_update	replace	resource_group_name, resource_name, time_series_database_connection_name, subscription_id		Create or update a time series database connection.
delete	delete	resource_group_name, resource_name, time_series_database_connection_name, subscription_id	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
resource_group_name	string	The name of the resource group that contains the DigitalTwinsInstance. Required.
resource_name	string	The name of the DigitalTwinsInstance. Required.
subscription_id	string
time_series_database_connection_name	string	Name of time series database connection. Required.
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. Known values are: "true" and "false". Default value is None.

SELECT examples

get

Get the description of an existing time series database connection.

SELECT
id,
name,
connectionType,
identity,
provisioningState,
systemData,
type
FROM azure.digital_twins.time_series_database_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND time_series_database_connection_name = '{{ time_series_database_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

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

SELECT
id,
name,
connectionType,
identity,
provisioningState,
systemData,
type
FROM azure.digital_twins.time_series_database_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a time series database connection.

INSERT INTO azure.digital_twins.time_series_database_connections (
properties,
resource_group_name,
resource_name,
time_series_database_connection_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ time_series_database_connection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: time_series_database_connections
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the time_series_database_connections resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the time_series_database_connections resource.
  - name: time_series_database_connection_name
    value: "{{ time_series_database_connection_name }}"
    description: Required parameter for the time_series_database_connections resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the time_series_database_connections resource.
  - name: properties
    description: |
      Properties of a specific time series database connection.
    value:
      connectionType: "{{ connectionType }}"
      provisioningState: "{{ provisioningState }}"
      identity:
        type: "{{ type }}"
        userAssignedIdentity: "{{ userAssignedIdentity }}"

REPLACE examples

create_or_update

Create or update a time series database connection.

REPLACE azure.digital_twins.time_series_database_connections
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND time_series_database_connection_name = '{{ time_series_database_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a time series database connection.

DELETE FROM azure.digital_twins.time_series_database_connections
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND time_series_database_connection_name = '{{ time_series_database_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND cleanupConnectionArtifacts = '{{ cleanupConnectionArtifacts }}'
;