Get-AzDigitalTwinsTimeSeriesDatabaseConnection
This cmdlet is part of a Preview module. Preview versions aren't recommended for use in production environments. For more information, see https://aka.ms/azps-refstatus .
Get the description of an existing time series database connection.
Syntax
List (Default)
Get-AzDigitalTwinsTimeSeriesDatabaseConnection
-ResourceGroupName <String>
-ResourceName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
GetViaIdentityDigitalTwinsInstance
Get-AzDigitalTwinsTimeSeriesDatabaseConnection
-Name <String>
-DigitalTwinsInstanceInputObject <IDigitalTwinsIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get
Get-AzDigitalTwinsTimeSeriesDatabaseConnection
-Name <String>
-ResourceGroupName <String>
-ResourceName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
GetViaIdentity
Get-AzDigitalTwinsTimeSeriesDatabaseConnection
-InputObject <IDigitalTwinsIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Description
Get the description of an existing time series database connection.
Examples
Example 1: List description of an existing time series database connection.
Get-AzDigitalTwinsTimeSeriesDatabaseConnection -ResourceGroupName azps_test_group -ResourceName azps-digitaltwins-instance
Name ConnectionType ProvisioningState ResourceGroupName
---- -------------- ----------------- -----------------
azps-tsdc AzureDataExplorer Succeed azps_test_group
List description of an existing time series database connection.
Example 2: Get the description of an existing time series database connection.
Get-AzDigitalTwinsTimeSeriesDatabaseConnection -ResourceGroupName azps_test_group -ResourceName azps-digitaltwins-instance -Name azps-tsdc
Name ConnectionType ProvisioningState ResourceGroupName
---- -------------- ----------------- -----------------
azps-tsdc AzureDataExplorer Succeed azps_test_group
Get the description of an existing time series database connection.
Parameters
-DefaultProfile
The DefaultProfile parameter is not functional.
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
GetViaIdentityDigitalTwinsInstance
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
GetViaIdentity
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-Name
Name of time series database connection.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: TimeSeriesDatabaseConnectionName
Parameter sets
GetViaIdentityDigitalTwinsInstance
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Get
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The name of the resource group that contains the DigitalTwinsInstance.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
List
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Get
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceName
The name of the DigitalTwinsInstance.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
List
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Get
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
The subscription identifier.
Parameter properties
Type: String [ ]
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
List
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Get
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
