Partilhar via


Time Series Database Connections - Get

Get the description of an existing time series database connection.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/timeSeriesDatabaseConnections/{timeSeriesDatabaseConnectionName}?api-version=2023-01-31

URI Parameters

Name In Required Type Description
resourceGroupName
path True

string

The name of the resource group that contains the DigitalTwinsInstance.

resourceName
path True

string

The name of the DigitalTwinsInstance.

Regex pattern: ^(?!-)[A-Za-z0-9-]{3,63}(?<!-)$

subscriptionId
path True

string

The subscription identifier.

timeSeriesDatabaseConnectionName
path True

string

Name of time series database connection.

Regex pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$

api-version
query True

string

Version of the DigitalTwinsInstance Management API.

Responses

Name Type Description
200 OK

TimeSeriesDatabaseConnection

Description of the time series connection.

Other Status Codes

ErrorResponse

Default error response

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Impersonate your user account

Examples

Get time series database connection for a DigitalTwins instance.

Sample request

GET https://management.azure.com/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourceGroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService/timeSeriesDatabaseConnections/myConnection?api-version=2023-01-31

Sample response

{
  "id": "/subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService/timeSeriesDatabaseConnections/myConnection",
  "type": "Microsoft.DigitalTwins/digitalTwinsInstances/timeSeriesDatabaseConnections",
  "name": "myConnection",
  "properties": {
    "connectionType": "AzureDataExplorer",
    "provisioningState": "Succeeded",
    "adxEndpointUri": "https://mycluster.kusto.windows.net",
    "adxResourceId": "/subscriptions/c493073e-2460-45ba-a403-f3e0df1e9feg/resourceGroups/testrg/providers/Microsoft.Kusto/clusters/mycluster",
    "adxDatabaseName": "myDatabase",
    "adxTableName": "myTable",
    "eventHubEndpointUri": "sb://myeh.servicebus.windows.net/",
    "eventHubEntityPath": "myeh",
    "eventHubConsumerGroup": "$Default",
    "eventHubNamespaceResourceId": "/subscriptions/c493073e-2460-45ba-a403-f3e0df1e9feg/resourceGroups/testrg/providers/Microsoft.EventHub/namespaces/myeh"
  }
}

Definitions

Name Description
AzureDataExplorerConnectionProperties

Properties of a time series database connection to Azure Data Explorer with data being sent via an EventHub.

createdByType

The type of identity that created the resource.

ErrorDefinition

Error definition.

ErrorResponse

Error response.

IdentityType

The type of managed identity used.

ManagedIdentityReference

The properties of the Managed Identity.

recordPropertyAndItemRemovals

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.

SystemData

Metadata pertaining to creation and last modification of the resource.

TimeSeriesDatabaseConnection

Describes a time series database connection resource.

TimeSeriesDatabaseConnectionState

The provisioning state.

AzureDataExplorerConnectionProperties

Properties of a time series database connection to Azure Data Explorer with data being sent via an EventHub.

Name Type Default value Description
adxDatabaseName

string

The name of the Azure Data Explorer database.

adxEndpointUri

string

The URI of the Azure Data Explorer endpoint.

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.

adxResourceId

string

The resource ID of the Azure Data Explorer cluster.

adxTableName

string

AdtPropertyEvents

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.

connectionType string:

AzureDataExplorer

The type of time series connection resource.

eventHubConsumerGroup

string

$Default

The EventHub consumer group to use when ADX reads from EventHub. Defaults to $Default.

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.

identity

ManagedIdentityReference

Managed identity properties for the time series database connection resource.

provisioningState

TimeSeriesDatabaseConnectionState

The provisioning state.

recordPropertyAndItemRemovals

recordPropertyAndItemRemovals

false

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.

createdByType

The type of identity that created the resource.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorDefinition

Error definition.

Name Type Description
code

string

Service specific error code which serves as the substatus for the HTTP error code.

details

ErrorDefinition[]

Internal error details.

message

string

Description of the error.

ErrorResponse

Error response.

Name Type Description
error

ErrorDefinition

Error description

IdentityType

The type of managed identity used.

Name Type Description
SystemAssigned

string

UserAssigned

string

ManagedIdentityReference

The properties of the Managed Identity.

Name Type Description
type

IdentityType

The type of managed identity used.

userAssignedIdentity

string

The user identity ARM resource id if the managed identity type is 'UserAssigned'.

recordPropertyAndItemRemovals

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.

Name Type Description
false

string

true

string

SystemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string

The timestamp of resource creation (UTC).

createdBy

string

The identity that created the resource.

createdByType

createdByType

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

createdByType

The type of identity that last modified the resource.

TimeSeriesDatabaseConnection

Describes a time series database connection resource.

Name Type Description
id

string

The resource identifier.

name

string

Extension resource name.

properties TimeSeriesDatabaseConnectionProperties:

AzureDataExplorerConnectionProperties

Properties of a specific time series database connection.

systemData

SystemData

Metadata pertaining to creation and last modification of the resource.

type

string

The resource type.

TimeSeriesDatabaseConnectionState

The provisioning state.

Name Type Description
Canceled

string

Deleted

string

Deleting

string

Disabled

string

Failed

string

Moving

string

Provisioning

string

Restoring

string

Succeeded

string

Suspending

string

Updating

string

Warning

string