Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. digitaltwins
  5. getTimeSeriesDatabaseConnection
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.digitaltwins.getTimeSeriesDatabaseConnection

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Get the description of an existing time series database connection.

Uses Azure REST API version 2023-01-31.

Using getTimeSeriesDatabaseConnection

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getTimeSeriesDatabaseConnection(args: GetTimeSeriesDatabaseConnectionArgs, opts?: InvokeOptions): Promise<GetTimeSeriesDatabaseConnectionResult>
function getTimeSeriesDatabaseConnectionOutput(args: GetTimeSeriesDatabaseConnectionOutputArgs, opts?: InvokeOptions): Output<GetTimeSeriesDatabaseConnectionResult>
Copy
def get_time_series_database_connection(resource_group_name: Optional[str] = None,
                                        resource_name: Optional[str] = None,
                                        time_series_database_connection_name: Optional[str] = None,
                                        opts: Optional[InvokeOptions] = None) -> GetTimeSeriesDatabaseConnectionResult
def get_time_series_database_connection_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                                        resource_name: Optional[pulumi.Input[str]] = None,
                                        time_series_database_connection_name: Optional[pulumi.Input[str]] = None,
                                        opts: Optional[InvokeOptions] = None) -> Output[GetTimeSeriesDatabaseConnectionResult]
Copy
func LookupTimeSeriesDatabaseConnection(ctx *Context, args *LookupTimeSeriesDatabaseConnectionArgs, opts ...InvokeOption) (*LookupTimeSeriesDatabaseConnectionResult, error)
func LookupTimeSeriesDatabaseConnectionOutput(ctx *Context, args *LookupTimeSeriesDatabaseConnectionOutputArgs, opts ...InvokeOption) LookupTimeSeriesDatabaseConnectionResultOutput
Copy

> Note: This function is named LookupTimeSeriesDatabaseConnection in the Go SDK.

public static class GetTimeSeriesDatabaseConnection 
{
    public static Task<GetTimeSeriesDatabaseConnectionResult> InvokeAsync(GetTimeSeriesDatabaseConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetTimeSeriesDatabaseConnectionResult> Invoke(GetTimeSeriesDatabaseConnectionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetTimeSeriesDatabaseConnectionResult> getTimeSeriesDatabaseConnection(GetTimeSeriesDatabaseConnectionArgs args, InvokeOptions options)
public static Output<GetTimeSeriesDatabaseConnectionResult> getTimeSeriesDatabaseConnection(GetTimeSeriesDatabaseConnectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:digitaltwins:getTimeSeriesDatabaseConnection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the DigitalTwinsInstance.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the DigitalTwinsInstance.
TimeSeriesDatabaseConnectionName
This property is required.
Changes to this property will trigger replacement.
string
Name of time series database connection.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the DigitalTwinsInstance.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the DigitalTwinsInstance.
TimeSeriesDatabaseConnectionName
This property is required.
Changes to this property will trigger replacement.
string
Name of time series database connection.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the DigitalTwinsInstance.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the DigitalTwinsInstance.
timeSeriesDatabaseConnectionName
This property is required.
Changes to this property will trigger replacement.
String
Name of time series database connection.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the DigitalTwinsInstance.
resourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the DigitalTwinsInstance.
timeSeriesDatabaseConnectionName
This property is required.
Changes to this property will trigger replacement.
string
Name of time series database connection.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group that contains the DigitalTwinsInstance.
resource_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the DigitalTwinsInstance.
time_series_database_connection_name
This property is required.
Changes to this property will trigger replacement.
str
Name of time series database connection.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the DigitalTwinsInstance.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the DigitalTwinsInstance.
timeSeriesDatabaseConnectionName
This property is required.
Changes to this property will trigger replacement.
String
Name of time series database connection.

getTimeSeriesDatabaseConnection Result

The following output properties are available:

Id string
The resource identifier.
Name string
Extension resource name.
Properties Pulumi.AzureNative.DigitalTwins.Outputs.AzureDataExplorerConnectionPropertiesResponse
Properties of a specific time series database connection.
SystemData Pulumi.AzureNative.DigitalTwins.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The resource type.
Id string
The resource identifier.
Name string
Extension resource name.
Properties AzureDataExplorerConnectionPropertiesResponse
Properties of a specific time series database connection.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The resource type.
id String
The resource identifier.
name String
Extension resource name.
properties AzureDataExplorerConnectionPropertiesResponse
Properties of a specific time series database connection.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
The resource type.
id string
The resource identifier.
name string
Extension resource name.
properties AzureDataExplorerConnectionPropertiesResponse
Properties of a specific time series database connection.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
The resource type.
id str
The resource identifier.
name str
Extension resource name.
properties AzureDataExplorerConnectionPropertiesResponse
Properties of a specific time series database connection.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
The resource type.
id String
The resource identifier.
name String
Extension resource name.
properties Property Map
Properties of a specific time series database connection.
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
The resource type.

Supporting Types

AzureDataExplorerConnectionPropertiesResponse

AdxDatabaseName This property is required. string
The name of the Azure Data Explorer database.
AdxEndpointUri This property is required. string
The URI of the Azure Data Explorer endpoint.
AdxResourceId This property is required. string
The resource ID of the Azure Data Explorer cluster.
EventHubEndpointUri This property is required. string
The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb://
EventHubEntityPath This property is required. string
The EventHub name in the EventHub namespace for identity-based authentication.
EventHubNamespaceResourceId This property is required. string
The resource ID of the EventHub namespace.
ProvisioningState This property is required. string
The provisioning state.
AdxRelationshipLifecycleEventsTableName string
The name of the Azure Data Explorer table used for recording relationship lifecycle events. The table will not be created if this property is left unspecified.
AdxTableName string
The name of the Azure Data Explorer table used for storing updates to properties of twins and relationships. Defaults to AdtPropertyEvents.
AdxTwinLifecycleEventsTableName string
The name of the Azure Data Explorer table used for recording twin lifecycle events. The table will not be created if this property is left unspecified.
EventHubConsumerGroup string
The EventHub consumer group to use when ADX reads from EventHub. Defaults to $Default.
Identity Pulumi.AzureNative.DigitalTwins.Inputs.ManagedIdentityReferenceResponse
Managed identity properties for the time series database connection resource.
RecordPropertyAndItemRemovals string
Specifies whether or not to record twin / relationship property and item removals, including removals of indexed or keyed values (such as map entries, array elements, etc.). This feature is de-activated unless explicitly set to 'true'. Setting this property to 'true' will generate an additional column in the property events table in ADX.
AdxDatabaseName This property is required. string
The name of the Azure Data Explorer database.
AdxEndpointUri This property is required. string
The URI of the Azure Data Explorer endpoint.
AdxResourceId This property is required. string
The resource ID of the Azure Data Explorer cluster.
EventHubEndpointUri This property is required. string
The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb://
EventHubEntityPath This property is required. string
The EventHub name in the EventHub namespace for identity-based authentication.
EventHubNamespaceResourceId This property is required. string
The resource ID of the EventHub namespace.
ProvisioningState This property is required. string
The provisioning state.
AdxRelationshipLifecycleEventsTableName string
The name of the Azure Data Explorer table used for recording relationship lifecycle events. The table will not be created if this property is left unspecified.
AdxTableName string
The name of the Azure Data Explorer table used for storing updates to properties of twins and relationships. Defaults to AdtPropertyEvents.
AdxTwinLifecycleEventsTableName string
The name of the Azure Data Explorer table used for recording twin lifecycle events. The table will not be created if this property is left unspecified.
EventHubConsumerGroup string
The EventHub consumer group to use when ADX reads from EventHub. Defaults to $Default.
Identity ManagedIdentityReferenceResponse
Managed identity properties for the time series database connection resource.
RecordPropertyAndItemRemovals string
Specifies whether or not to record twin / relationship property and item removals, including removals of indexed or keyed values (such as map entries, array elements, etc.). This feature is de-activated unless explicitly set to 'true'. Setting this property to 'true' will generate an additional column in the property events table in ADX.
adxDatabaseName This property is required. String
The name of the Azure Data Explorer database.
adxEndpointUri This property is required. String
The URI of the Azure Data Explorer endpoint.
adxResourceId This property is required. String
The resource ID of the Azure Data Explorer cluster.
eventHubEndpointUri This property is required. String
The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb://
eventHubEntityPath This property is required. String
The EventHub name in the EventHub namespace for identity-based authentication.
eventHubNamespaceResourceId This property is required. String
The resource ID of the EventHub namespace.
provisioningState This property is required. String
The provisioning state.
adxRelationshipLifecycleEventsTableName String
The name of the Azure Data Explorer table used for recording relationship lifecycle events. The table will not be created if this property is left unspecified.
adxTableName String
The name of the Azure Data Explorer table used for storing updates to properties of twins and relationships. Defaults to AdtPropertyEvents.
adxTwinLifecycleEventsTableName String
The name of the Azure Data Explorer table used for recording twin lifecycle events. The table will not be created if this property is left unspecified.
eventHubConsumerGroup String
The EventHub consumer group to use when ADX reads from EventHub. Defaults to $Default.
identity ManagedIdentityReferenceResponse
Managed identity properties for the time series database connection resource.
recordPropertyAndItemRemovals String
Specifies whether or not to record twin / relationship property and item removals, including removals of indexed or keyed values (such as map entries, array elements, etc.). This feature is de-activated unless explicitly set to 'true'. Setting this property to 'true' will generate an additional column in the property events table in ADX.
adxDatabaseName This property is required. string
The name of the Azure Data Explorer database.
adxEndpointUri This property is required. string
The URI of the Azure Data Explorer endpoint.
adxResourceId This property is required. string
The resource ID of the Azure Data Explorer cluster.
eventHubEndpointUri This property is required. string
The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb://
eventHubEntityPath This property is required. string
The EventHub name in the EventHub namespace for identity-based authentication.
eventHubNamespaceResourceId This property is required. string
The resource ID of the EventHub namespace.
provisioningState This property is required. string
The provisioning state.
adxRelationshipLifecycleEventsTableName string
The name of the Azure Data Explorer table used for recording relationship lifecycle events. The table will not be created if this property is left unspecified.
adxTableName string
The name of the Azure Data Explorer table used for storing updates to properties of twins and relationships. Defaults to AdtPropertyEvents.
adxTwinLifecycleEventsTableName string
The name of the Azure Data Explorer table used for recording twin lifecycle events. The table will not be created if this property is left unspecified.
eventHubConsumerGroup string
The EventHub consumer group to use when ADX reads from EventHub. Defaults to $Default.
identity ManagedIdentityReferenceResponse
Managed identity properties for the time series database connection resource.
recordPropertyAndItemRemovals string
Specifies whether or not to record twin / relationship property and item removals, including removals of indexed or keyed values (such as map entries, array elements, etc.). This feature is de-activated unless explicitly set to 'true'. Setting this property to 'true' will generate an additional column in the property events table in ADX.
adx_database_name This property is required. str
The name of the Azure Data Explorer database.
adx_endpoint_uri This property is required. str
The URI of the Azure Data Explorer endpoint.
adx_resource_id This property is required. str
The resource ID of the Azure Data Explorer cluster.
event_hub_endpoint_uri This property is required. str
The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb://
event_hub_entity_path This property is required. str
The EventHub name in the EventHub namespace for identity-based authentication.
event_hub_namespace_resource_id This property is required. str
The resource ID of the EventHub namespace.
provisioning_state This property is required. str
The provisioning state.
adx_relationship_lifecycle_events_table_name str
The name of the Azure Data Explorer table used for recording relationship lifecycle events. The table will not be created if this property is left unspecified.
adx_table_name str
The name of the Azure Data Explorer table used for storing updates to properties of twins and relationships. Defaults to AdtPropertyEvents.
adx_twin_lifecycle_events_table_name str
The name of the Azure Data Explorer table used for recording twin lifecycle events. The table will not be created if this property is left unspecified.
event_hub_consumer_group str
The EventHub consumer group to use when ADX reads from EventHub. Defaults to $Default.
identity ManagedIdentityReferenceResponse
Managed identity properties for the time series database connection resource.
record_property_and_item_removals str
Specifies whether or not to record twin / relationship property and item removals, including removals of indexed or keyed values (such as map entries, array elements, etc.). This feature is de-activated unless explicitly set to 'true'. Setting this property to 'true' will generate an additional column in the property events table in ADX.
adxDatabaseName This property is required. String
The name of the Azure Data Explorer database.
adxEndpointUri This property is required. String
The URI of the Azure Data Explorer endpoint.
adxResourceId This property is required. String
The resource ID of the Azure Data Explorer cluster.
eventHubEndpointUri This property is required. String
The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb://
eventHubEntityPath This property is required. String
The EventHub name in the EventHub namespace for identity-based authentication.
eventHubNamespaceResourceId This property is required. String
The resource ID of the EventHub namespace.
provisioningState This property is required. String
The provisioning state.
adxRelationshipLifecycleEventsTableName String
The name of the Azure Data Explorer table used for recording relationship lifecycle events. The table will not be created if this property is left unspecified.
adxTableName String
The name of the Azure Data Explorer table used for storing updates to properties of twins and relationships. Defaults to AdtPropertyEvents.
adxTwinLifecycleEventsTableName String
The name of the Azure Data Explorer table used for recording twin lifecycle events. The table will not be created if this property is left unspecified.
eventHubConsumerGroup String
The EventHub consumer group to use when ADX reads from EventHub. Defaults to $Default.
identity Property Map
Managed identity properties for the time series database connection resource.
recordPropertyAndItemRemovals String
Specifies whether or not to record twin / relationship property and item removals, including removals of indexed or keyed values (such as map entries, array elements, etc.). This feature is de-activated unless explicitly set to 'true'. Setting this property to 'true' will generate an additional column in the property events table in ADX.

ManagedIdentityReferenceResponse

Type string
The type of managed identity used.
UserAssignedIdentity string
The user identity ARM resource id if the managed identity type is 'UserAssigned'.
Type string
The type of managed identity used.
UserAssignedIdentity string
The user identity ARM resource id if the managed identity type is 'UserAssigned'.
type String
The type of managed identity used.
userAssignedIdentity String
The user identity ARM resource id if the managed identity type is 'UserAssigned'.
type string
The type of managed identity used.
userAssignedIdentity string
The user identity ARM resource id if the managed identity type is 'UserAssigned'.
type str
The type of managed identity used.
user_assigned_identity str
The user identity ARM resource id if the managed identity type is 'UserAssigned'.
type String
The type of managed identity used.
userAssignedIdentity String
The user identity ARM resource id if the managed identity type is 'UserAssigned'.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native