TimeSeriesDatabaseConnections Interface

Package:

com.azure.resourcemanager.digitaltwins.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-digitaltwins:1.3.0

public interface TimeSeriesDatabaseConnections

Resource collection API of TimeSeriesDatabaseConnections.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new TimeSeriesDatabaseConnection resource.
abstract TimeSeriesDatabaseConnection	delete(String resourceGroupName, String resourceName, String timeSeriesDatabaseConnectionName) Delete a time series database connection.
abstract TimeSeriesDatabaseConnection	delete(String resourceGroupName, String resourceName, String timeSeriesDatabaseConnectionName, CleanupConnectionArtifacts cleanupConnectionArtifacts, Context context) Delete a time series database connection.
abstract TimeSeriesDatabaseConnection	deleteById(String id) Delete a time series database connection.
abstract TimeSeriesDatabaseConnection	deleteByIdWithResponse(String id, CleanupConnectionArtifacts cleanupConnectionArtifacts, Context context) Delete a time series database connection.
abstract TimeSeriesDatabaseConnection	get(String resourceGroupName, String resourceName, String timeSeriesDatabaseConnectionName) Get the description of an existing time series database connection.
abstract TimeSeriesDatabaseConnection	getById(String id) Get the description of an existing time series database connection.
abstract Response<TimeSeriesDatabaseConnection>	getByIdWithResponse(String id, Context context) Get the description of an existing time series database connection.
abstract Response<TimeSeriesDatabaseConnection>	getWithResponse(String resourceGroupName, String resourceName, String timeSeriesDatabaseConnectionName, Context context) Get the description of an existing time series database connection.
abstract PagedIterable<TimeSeriesDatabaseConnection>	list(String resourceGroupName, String resourceName) Get all existing time series database connections for this DigitalTwins instance.
abstract PagedIterable<TimeSeriesDatabaseConnection>	list(String resourceGroupName, String resourceName, Context context) Get all existing time series database connections for this DigitalTwins instance.

Method Details

define

public abstract TimeSeriesDatabaseConnection.DefinitionStages.Blank define(String name)

Begins definition for a new TimeSeriesDatabaseConnection resource.

Parameters:

name - resource name.

Returns:

the first stage of the new TimeSeriesDatabaseConnection definition.

delete

public abstract TimeSeriesDatabaseConnection delete(String resourceGroupName, String resourceName, String timeSeriesDatabaseConnectionName)

Delete a time series database connection.

Parameters:

resourceGroupName - The name of the resource group that contains the DigitalTwinsInstance.

resourceName - The name of the DigitalTwinsInstance.

timeSeriesDatabaseConnectionName - Name of time series database connection.

Returns:

describes a time series database connection resource.

delete

public abstract TimeSeriesDatabaseConnection delete(String resourceGroupName, String resourceName, String timeSeriesDatabaseConnectionName, CleanupConnectionArtifacts cleanupConnectionArtifacts, Context context)

Delete a time series database connection.

Parameters:

resourceGroupName - The name of the resource group that contains the DigitalTwinsInstance.

resourceName - The name of the DigitalTwinsInstance.

timeSeriesDatabaseConnectionName - Name of time series database connection.

cleanupConnectionArtifacts - Specifies whether or not to attempt to clean up artifacts that were created in order to establish a connection to the time series database. This is a best-effort attempt that will fail if appropriate permissions are not in place. Setting this to 'true' does not delete any recorded data.

context - The context to associate with this operation.

Returns:

describes a time series database connection resource.

deleteById

public abstract TimeSeriesDatabaseConnection deleteById(String id)

Delete a time series database connection.

Parameters:

id - the resource ID.

Returns:

describes a time series database connection resource.

deleteByIdWithResponse

public abstract TimeSeriesDatabaseConnection deleteByIdWithResponse(String id, CleanupConnectionArtifacts cleanupConnectionArtifacts, Context context)

Delete a time series database connection.

Parameters:

id - the resource ID.

cleanupConnectionArtifacts - Specifies whether or not to attempt to clean up artifacts that were created in order to establish a connection to the time series database. This is a best-effort attempt that will fail if appropriate permissions are not in place. Setting this to 'true' does not delete any recorded data.

context - The context to associate with this operation.

Returns:

describes a time series database connection resource.

get

public abstract TimeSeriesDatabaseConnection get(String resourceGroupName, String resourceName, String timeSeriesDatabaseConnectionName)

Get the description of an existing time series database connection.

Parameters:

resourceGroupName - The name of the resource group that contains the DigitalTwinsInstance.

resourceName - The name of the DigitalTwinsInstance.

timeSeriesDatabaseConnectionName - Name of time series database connection.

Returns:

the description of an existing time series database connection.

getById

public abstract TimeSeriesDatabaseConnection getById(String id)

Get the description of an existing time series database connection.

Parameters:

id - the resource ID.

Returns:

the description of an existing time series database connection along with Response<T>.

getByIdWithResponse

public abstract Response<TimeSeriesDatabaseConnection> getByIdWithResponse(String id, Context context)

Get the description of an existing time series database connection.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the description of an existing time series database connection along with Response<T>.

getWithResponse

public abstract Response<TimeSeriesDatabaseConnection> getWithResponse(String resourceGroupName, String resourceName, String timeSeriesDatabaseConnectionName, Context context)

Get the description of an existing time series database connection.

Parameters:

resourceGroupName - The name of the resource group that contains the DigitalTwinsInstance.

resourceName - The name of the DigitalTwinsInstance.

timeSeriesDatabaseConnectionName - Name of time series database connection.

context - The context to associate with this operation.

Returns:

the description of an existing time series database connection along with Response<T>.

list

public abstract PagedIterable<TimeSeriesDatabaseConnection> list(String resourceGroupName, String resourceName)

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

Parameters:

resourceGroupName - The name of the resource group that contains the DigitalTwinsInstance.

resourceName - The name of the DigitalTwinsInstance.

Returns:

all existing time series database connections for this DigitalTwins instance as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<TimeSeriesDatabaseConnection> list(String resourceGroupName, String resourceName, Context context)

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

Parameters:

resourceGroupName - The name of the resource group that contains the DigitalTwinsInstance.

resourceName - The name of the DigitalTwinsInstance.

context - The context to associate with this operation.

Returns:

all existing time series database connections for this DigitalTwins instance as paginated response with PagedIterable<T>.