Azure Native v1.102.0, May 2 23

azure-native.digitaltwins.getTimeSeriesDatabaseConnection

Explore with Pulumi AI

Get the description of an existing time series database connection. API Version: 2021-06-30-preview.

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>

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]

func LookupTimeSeriesDatabaseConnection(ctx *Context, args *LookupTimeSeriesDatabaseConnectionArgs, opts ...InvokeOption) (*LookupTimeSeriesDatabaseConnectionResult, error)
func LookupTimeSeriesDatabaseConnectionOutput(ctx *Context, args *LookupTimeSeriesDatabaseConnectionOutputArgs, opts ...InvokeOption) LookupTimeSeriesDatabaseConnectionResultOutput

> 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)
}

public static CompletableFuture<GetTimeSeriesDatabaseConnectionResult> getTimeSeriesDatabaseConnection(GetTimeSeriesDatabaseConnectionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:digitaltwins:getTimeSeriesDatabaseConnection
  arguments:
    # arguments dictionary

The following arguments are supported:

ResourceGroupName string: The name of the resource group that contains the DigitalTwinsInstance.
ResourceName string: The name of the DigitalTwinsInstance.
TimeSeriesDatabaseConnectionName string: Name of time series database connection.

ResourceGroupName string: The name of the resource group that contains the DigitalTwinsInstance.
ResourceName string: The name of the DigitalTwinsInstance.
TimeSeriesDatabaseConnectionName string: Name of time series database connection.

resourceGroupName String: The name of the resource group that contains the DigitalTwinsInstance.
resourceName String: The name of the DigitalTwinsInstance.
timeSeriesDatabaseConnectionName String: Name of time series database connection.

resourceGroupName string: The name of the resource group that contains the DigitalTwinsInstance.
resourceName string: The name of the DigitalTwinsInstance.
timeSeriesDatabaseConnectionName string: Name of time series database connection.

resource_group_name str: The name of the resource group that contains the DigitalTwinsInstance.
resource_name str: The name of the DigitalTwinsInstance.
time_series_database_connection_name str: Name of time series database connection.

resourceGroupName String: The name of the resource group that contains the DigitalTwinsInstance.
resourceName String: The name of the DigitalTwinsInstance.
timeSeriesDatabaseConnectionName 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 string: The name of the Azure Data Explorer database.
AdxEndpointUri string: The URI of the Azure Data Explorer endpoint.
AdxResourceId string: The resource ID of the Azure Data Explorer cluster.
EventHubEndpointUri string: The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb://
EventHubEntityPath string: The EventHub name in the EventHub namespace for identity-based authentication.
EventHubNamespaceResourceId string: The resource ID of the EventHub namespace.
ProvisioningState string: The provisioning state.
AdxTableName string: The name of the Azure Data Explorer table. Defaults to AdtPropertyEvents.
EventHubConsumerGroup string: The EventHub consumer group to use when ADX reads from EventHub. Defaults to $Default.

AdxDatabaseName string: The name of the Azure Data Explorer database.
AdxEndpointUri string: The URI of the Azure Data Explorer endpoint.
AdxResourceId string: The resource ID of the Azure Data Explorer cluster.
EventHubEndpointUri string: The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb://
EventHubEntityPath string: The EventHub name in the EventHub namespace for identity-based authentication.
EventHubNamespaceResourceId string: The resource ID of the EventHub namespace.
ProvisioningState string: The provisioning state.
AdxTableName string: The name of the Azure Data Explorer table. Defaults to AdtPropertyEvents.
EventHubConsumerGroup string: The EventHub consumer group to use when ADX reads from EventHub. Defaults to $Default.

adxDatabaseName String: The name of the Azure Data Explorer database.
adxEndpointUri String: The URI of the Azure Data Explorer endpoint.
adxResourceId String: The resource ID of the Azure Data Explorer cluster.
eventHubEndpointUri String: The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb://
eventHubEntityPath String: The EventHub name in the EventHub namespace for identity-based authentication.
eventHubNamespaceResourceId String: The resource ID of the EventHub namespace.
provisioningState String: The provisioning state.
adxTableName String: The name of the Azure Data Explorer table. Defaults to AdtPropertyEvents.
eventHubConsumerGroup String: The EventHub consumer group to use when ADX reads from EventHub. Defaults to $Default.

adxDatabaseName string: The name of the Azure Data Explorer database.
adxEndpointUri string: The URI of the Azure Data Explorer endpoint.
adxResourceId string: The resource ID of the Azure Data Explorer cluster.
eventHubEndpointUri string: The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb://
eventHubEntityPath string: The EventHub name in the EventHub namespace for identity-based authentication.
eventHubNamespaceResourceId string: The resource ID of the EventHub namespace.
provisioningState string: The provisioning state.
adxTableName string: The name of the Azure Data Explorer table. Defaults to AdtPropertyEvents.
eventHubConsumerGroup string: The EventHub consumer group to use when ADX reads from EventHub. Defaults to $Default.

adx_database_name str: The name of the Azure Data Explorer database.
adx_endpoint_uri str: The URI of the Azure Data Explorer endpoint.
adx_resource_id str: The resource ID of the Azure Data Explorer cluster.
event_hub_endpoint_uri str: The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb://
event_hub_entity_path str: The EventHub name in the EventHub namespace for identity-based authentication.
event_hub_namespace_resource_id str: The resource ID of the EventHub namespace.
provisioning_state str: The provisioning state.
adx_table_name str: The name of the Azure Data Explorer table. Defaults to AdtPropertyEvents.
event_hub_consumer_group str: The EventHub consumer group to use when ADX reads from EventHub. Defaults to $Default.

adxDatabaseName String: The name of the Azure Data Explorer database.
adxEndpointUri String: The URI of the Azure Data Explorer endpoint.
adxResourceId String: The resource ID of the Azure Data Explorer cluster.
eventHubEndpointUri String: The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb://
eventHubEntityPath String: The EventHub name in the EventHub namespace for identity-based authentication.
eventHubNamespaceResourceId String: The resource ID of the EventHub namespace.
provisioningState String: The provisioning state.
adxTableName String: The name of the Azure Data Explorer table. Defaults to AdtPropertyEvents.
eventHubConsumerGroup String: The EventHub consumer group to use when ADX reads from EventHub. Defaults to $Default.

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