TimeSeriesDatabaseConnections | @azure/arm-digitaltwins

Interface representing a TimeSeriesDatabaseConnections.

Hierarchy

TimeSeriesDatabaseConnections

Implemented by

TimeSeriesDatabaseConnectionsImpl

Index

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, resourceName: string, timeSeriesDatabaseConnectionName: string, timeSeriesDatabaseConnectionDescription: TimeSeriesDatabaseConnection, options?: TimeSeriesDatabaseConnectionsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<TimeSeriesDatabaseConnectionsCreateOrUpdateResponse>, TimeSeriesDatabaseConnectionsCreateOrUpdateResponse>>

- Defined in operationsInterfaces/timeSeriesDatabaseConnections.ts:57
Create or update a time series database connection.

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.
- Optional options: TimeSeriesDatabaseConnectionsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<TimeSeriesDatabaseConnectionsCreateOrUpdateResponse>, TimeSeriesDatabaseConnectionsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

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

- Defined in operationsInterfaces/timeSeriesDatabaseConnections.ts:77
Create or update a time series database connection.

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.
- Optional options: TimeSeriesDatabaseConnectionsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<TimeSeriesDatabaseConnectionsCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, resourceName: string, timeSeriesDatabaseConnectionName: string, options?: TimeSeriesDatabaseConnectionsDeleteOptionalParams): Promise<PollerLike<PollOperationState<TimeSeriesDatabaseConnectionsDeleteResponse>, TimeSeriesDatabaseConnectionsDeleteResponse>>

- Defined in operationsInterfaces/timeSeriesDatabaseConnections.ts:91
Delete a time series database connection.

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.
- Optional options: TimeSeriesDatabaseConnectionsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<TimeSeriesDatabaseConnectionsDeleteResponse>, TimeSeriesDatabaseConnectionsDeleteResponse>>

beginDeleteAndWait

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

- Defined in operationsInterfaces/timeSeriesDatabaseConnections.ts:109
Delete a time series database connection.

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.
- Optional options: TimeSeriesDatabaseConnectionsDeleteOptionalParams
  
  The options parameters.
Returns Promise<TimeSeriesDatabaseConnectionsDeleteResponse>

get

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

- Defined in operationsInterfaces/timeSeriesDatabaseConnections.ts:43
Get the description of an existing time series database connection.

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.
- Optional options: TimeSeriesDatabaseConnectionsGetOptionalParams
  
  The options parameters.
Returns Promise<TimeSeriesDatabaseConnectionsGetResponse>

list

list(resourceGroupName: string, resourceName: string, options?: TimeSeriesDatabaseConnectionsListOptionalParams): PagedAsyncIterableIterator<TimeSeriesDatabaseConnection>

- Defined in operationsInterfaces/timeSeriesDatabaseConnections.ts:31
Get all existing time series database connections for this DigitalTwins instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the DigitalTwinsInstance.
- resourceName: string
  
  The name of the DigitalTwinsInstance.
- Optional options: TimeSeriesDatabaseConnectionsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<TimeSeriesDatabaseConnection>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

resourceName: string

timeSeriesDatabaseConnectionName: string

timeSeriesDatabaseConnectionDescription: TimeSeriesDatabaseConnection

Optional options: TimeSeriesDatabaseConnectionsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<TimeSeriesDatabaseConnectionsCreateOrUpdateResponse>, TimeSeriesDatabaseConnectionsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

resourceName: string

timeSeriesDatabaseConnectionName: string

timeSeriesDatabaseConnectionDescription: TimeSeriesDatabaseConnection

Optional options: TimeSeriesDatabaseConnectionsCreateOrUpdateOptionalParams

Returns Promise<TimeSeriesDatabaseConnectionsCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

resourceName: string

timeSeriesDatabaseConnectionName: string

Optional options: TimeSeriesDatabaseConnectionsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<TimeSeriesDatabaseConnectionsDeleteResponse>, TimeSeriesDatabaseConnectionsDeleteResponse>>

beginDeleteAndWait

Parameters

resourceGroupName: string

resourceName: string

timeSeriesDatabaseConnectionName: string

Optional options: TimeSeriesDatabaseConnectionsDeleteOptionalParams

Returns Promise<TimeSeriesDatabaseConnectionsDeleteResponse>

get

Parameters

resourceGroupName: string

resourceName: string

timeSeriesDatabaseConnectionName: string

Optional options: TimeSeriesDatabaseConnectionsGetOptionalParams

Returns Promise<TimeSeriesDatabaseConnectionsGetResponse>

list

Parameters

resourceGroupName: string

resourceName: string

Optional options: TimeSeriesDatabaseConnectionsListOptionalParams

Returns PagedAsyncIterableIterator<TimeSeriesDatabaseConnection>