TimeSeriesDatabaseConnections interface

Package:

@azure/arm-digitaltwins

Interface representing a TimeSeriesDatabaseConnections.

Methods

beginCreateOrUpdate(string, string, string, TimeSeriesDatabaseConnection, TimeSeriesDatabaseConnectionsCreateOrUpdateOptionalParams)	Create or update a time series database connection.
beginCreateOrUpdateAndWait(string, string, string, TimeSeriesDatabaseConnection, TimeSeriesDatabaseConnectionsCreateOrUpdateOptionalParams)	Create or update a time series database connection.
beginDelete(string, string, string, TimeSeriesDatabaseConnectionsDeleteOptionalParams)	Delete a time series database connection.
beginDeleteAndWait(string, string, string, TimeSeriesDatabaseConnectionsDeleteOptionalParams)	Delete a time series database connection.
get(string, string, string, TimeSeriesDatabaseConnectionsGetOptionalParams)	Get the description of an existing time series database connection.
list(string, string, TimeSeriesDatabaseConnectionsListOptionalParams)	Get all existing time series database connections for this DigitalTwins instance.

Method Details

beginCreateOrUpdate(string, string, string, TimeSeriesDatabaseConnection, TimeSeriesDatabaseConnectionsCreateOrUpdateOptionalParams)

Create or update a time series database connection.

function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, timeSeriesDatabaseConnectionName: string, timeSeriesDatabaseConnectionDescription: TimeSeriesDatabaseConnection, options?: TimeSeriesDatabaseConnectionsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<TimeSeriesDatabaseConnection>, TimeSeriesDatabaseConnection>>

Parameters

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.

timeSeriesDatabaseConnectionDescription

TimeSeriesDatabaseConnection

The time series database connection description.

options

TimeSeriesDatabaseConnectionsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<TimeSeriesDatabaseConnection>, TimeSeriesDatabaseConnection>>

beginCreateOrUpdateAndWait(string, string, string, TimeSeriesDatabaseConnection, TimeSeriesDatabaseConnectionsCreateOrUpdateOptionalParams)

Create or update a time series database connection.

function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, timeSeriesDatabaseConnectionName: string, timeSeriesDatabaseConnectionDescription: TimeSeriesDatabaseConnection, options?: TimeSeriesDatabaseConnectionsCreateOrUpdateOptionalParams): Promise<TimeSeriesDatabaseConnection>

Parameters

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.

timeSeriesDatabaseConnectionDescription

TimeSeriesDatabaseConnection

The time series database connection description.

options

TimeSeriesDatabaseConnectionsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<TimeSeriesDatabaseConnection>

beginDelete(string, string, string, TimeSeriesDatabaseConnectionsDeleteOptionalParams)

Delete a time series database connection.

function beginDelete(resourceGroupName: string, resourceName: string, timeSeriesDatabaseConnectionName: string, options?: TimeSeriesDatabaseConnectionsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<TimeSeriesDatabaseConnection>, TimeSeriesDatabaseConnection>>

Parameters

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.

options

TimeSeriesDatabaseConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<TimeSeriesDatabaseConnection>, TimeSeriesDatabaseConnection>>

beginDeleteAndWait(string, string, string, TimeSeriesDatabaseConnectionsDeleteOptionalParams)

Delete a time series database connection.

function beginDeleteAndWait(resourceGroupName: string, resourceName: string, timeSeriesDatabaseConnectionName: string, options?: TimeSeriesDatabaseConnectionsDeleteOptionalParams): Promise<TimeSeriesDatabaseConnection>

Parameters

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.

options

TimeSeriesDatabaseConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<TimeSeriesDatabaseConnection>

get(string, string, string, TimeSeriesDatabaseConnectionsGetOptionalParams)

Get the description of an existing time series database connection.

function get(resourceGroupName: string, resourceName: string, timeSeriesDatabaseConnectionName: string, options?: TimeSeriesDatabaseConnectionsGetOptionalParams): Promise<TimeSeriesDatabaseConnection>

Parameters

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.

options

TimeSeriesDatabaseConnectionsGetOptionalParams

The options parameters.

Returns

Promise<TimeSeriesDatabaseConnection>

list(string, string, TimeSeriesDatabaseConnectionsListOptionalParams)

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

function list(resourceGroupName: string, resourceName: string, options?: TimeSeriesDatabaseConnectionsListOptionalParams): PagedAsyncIterableIterator<TimeSeriesDatabaseConnection, TimeSeriesDatabaseConnection[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group that contains the DigitalTwinsInstance.

resourceName

string

The name of the DigitalTwinsInstance.

options

TimeSeriesDatabaseConnectionsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<TimeSeriesDatabaseConnection, TimeSeriesDatabaseConnection[], PageSettings>