Package com.azure.resourcemanager.digitaltwins.models

Interface TimeSeriesDatabaseConnections

public interface TimeSeriesDatabaseConnections
Resource collection API of TimeSeriesDatabaseConnections.

  • Method Details

    • list

      com.azure.core.http.rest.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • list

      com.azure.core.http.rest.PagedIterable<TimeSeriesDatabaseConnection> list(String resourceGroupName, String resourceName, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • get

      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getWithResponse

      com.azure.core.http.rest.Response<TimeSeriesDatabaseConnection> getWithResponse(String resourceGroupName, String resourceName, String timeSeriesDatabaseConnectionName, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      TimeSeriesDatabaseConnection delete(String resourceGroupName, String resourceName, String timeSeriesDatabaseConnectionName, com.azure.core.util.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.
      context - The context to associate with this operation.
      Returns:
      describes a time series database connection resource.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getById

      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<TimeSeriesDatabaseConnection> getByIdWithResponse(String id, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteById

      TimeSeriesDatabaseConnection deleteById(String id)
      Delete a time series database connection.
      Parameters:
      id - the resource ID.
      Returns:
      describes a time series database connection resource.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteByIdWithResponse

      TimeSeriesDatabaseConnection deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Delete a time series database connection.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      describes a time series database connection resource.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • define

      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.