Show / Hide Table of Contents

Class DatabaseToolsClient

Service client instance for DatabaseTools.

Inheritance
object
ClientBase
RegionalClientBase
DatabaseToolsClient
Implements
IDisposable
Inherited Members
RegionalClientBase.logger
RegionalClientBase.SetRegion(Region)
RegionalClientBase.SetRegion(string)
RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)
RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)
RegionalClientBase.parseEndpointForParameters(string)
ClientBase.restClient
ClientBase.service
ClientBase.userAgent
ClientBase.Dispose()
ClientBase.Dispose(bool)
ClientBase.SetEndpoint(string)
ClientBase.GetEndpoint()
ClientBase.GetUserAgent()
ClientBase.SetRealmSpecificEndpointTemplate(string)
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.DatabasetoolsService
Assembly: OCI.DotNetSDK.Databasetools.dll
Syntax
public class DatabaseToolsClient : RegionalClientBase, IDisposable

Constructors

DatabaseToolsClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)

Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.

Declaration
public DatabaseToolsClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type Name Description
IBasicAuthenticationDetailsProvider authenticationDetailsProvider

The authentication details provider. Required.

ClientConfiguration clientConfiguration

The client configuration that contains settings to adjust REST client behaviors. Optional.

string endpoint

The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional.

Properties

Paginators

Declaration
public DatabaseToolsPaginators Paginators { get; }
Property Value
Type Description
DatabaseToolsPaginators

Waiters

Declaration
public DatabaseToolsWaiters Waiters { get; }
Property Value
Type Description
DatabaseToolsWaiters

Methods

AddDatabaseToolsConnectionLock(AddDatabaseToolsConnectionLockRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Adds a lock to a DatabaseToolsConnection resource.

Declaration
public Task<AddDatabaseToolsConnectionLockResponse> AddDatabaseToolsConnectionLock(AddDatabaseToolsConnectionLockRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
AddDatabaseToolsConnectionLockRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<AddDatabaseToolsConnectionLockResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use AddDatabaseToolsConnectionLock API.

AddDatabaseToolsPrivateEndpointLock(AddDatabaseToolsPrivateEndpointLockRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Adds a lock to a DatabaseToolsPrivateEndpoint resource.

Declaration
public Task<AddDatabaseToolsPrivateEndpointLockResponse> AddDatabaseToolsPrivateEndpointLock(AddDatabaseToolsPrivateEndpointLockRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
AddDatabaseToolsPrivateEndpointLockRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<AddDatabaseToolsPrivateEndpointLockResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use AddDatabaseToolsPrivateEndpointLock API.

ChangeDatabaseToolsConnectionCompartment(ChangeDatabaseToolsConnectionCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the specified Database Tools connection to a different compartment in the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration
public Task<ChangeDatabaseToolsConnectionCompartmentResponse> ChangeDatabaseToolsConnectionCompartment(ChangeDatabaseToolsConnectionCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeDatabaseToolsConnectionCompartmentRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ChangeDatabaseToolsConnectionCompartmentResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeDatabaseToolsConnectionCompartment API.

ChangeDatabaseToolsPrivateEndpointCompartment(ChangeDatabaseToolsPrivateEndpointCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a Database Tools private endpoint into a different compartment in the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration
public Task<ChangeDatabaseToolsPrivateEndpointCompartmentResponse> ChangeDatabaseToolsPrivateEndpointCompartment(ChangeDatabaseToolsPrivateEndpointCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeDatabaseToolsPrivateEndpointCompartmentRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ChangeDatabaseToolsPrivateEndpointCompartmentResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeDatabaseToolsPrivateEndpointCompartment API.

CreateDatabaseToolsConnection(CreateDatabaseToolsConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new Database Tools connection.

Declaration
public Task<CreateDatabaseToolsConnectionResponse> CreateDatabaseToolsConnection(CreateDatabaseToolsConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateDatabaseToolsConnectionRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CreateDatabaseToolsConnectionResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateDatabaseToolsConnection API.

CreateDatabaseToolsPrivateEndpoint(CreateDatabaseToolsPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new Database Tools private endpoint.

Declaration
public Task<CreateDatabaseToolsPrivateEndpointResponse> CreateDatabaseToolsPrivateEndpoint(CreateDatabaseToolsPrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateDatabaseToolsPrivateEndpointRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CreateDatabaseToolsPrivateEndpointResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateDatabaseToolsPrivateEndpoint API.

DeleteDatabaseToolsConnection(DeleteDatabaseToolsConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified Database Tools connection resource.

Declaration
public Task<DeleteDatabaseToolsConnectionResponse> DeleteDatabaseToolsConnection(DeleteDatabaseToolsConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteDatabaseToolsConnectionRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<DeleteDatabaseToolsConnectionResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteDatabaseToolsConnection API.

DeleteDatabaseToolsPrivateEndpoint(DeleteDatabaseToolsPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified Database Tools private endpoint.

Declaration
public Task<DeleteDatabaseToolsPrivateEndpointResponse> DeleteDatabaseToolsPrivateEndpoint(DeleteDatabaseToolsPrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteDatabaseToolsPrivateEndpointRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<DeleteDatabaseToolsPrivateEndpointResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteDatabaseToolsPrivateEndpoint API.

GetDatabaseToolsConnection(GetDatabaseToolsConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets details of the specified Database Tools connection.

Declaration
public Task<GetDatabaseToolsConnectionResponse> GetDatabaseToolsConnection(GetDatabaseToolsConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetDatabaseToolsConnectionRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetDatabaseToolsConnectionResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDatabaseToolsConnection API.

GetDatabaseToolsEndpointService(GetDatabaseToolsEndpointServiceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets details for the specified Database Tools endpoint service.

Declaration
public Task<GetDatabaseToolsEndpointServiceResponse> GetDatabaseToolsEndpointService(GetDatabaseToolsEndpointServiceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetDatabaseToolsEndpointServiceRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetDatabaseToolsEndpointServiceResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDatabaseToolsEndpointService API.

GetDatabaseToolsPrivateEndpoint(GetDatabaseToolsPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets details of a specified Database Tools private endpoint.

Declaration
public Task<GetDatabaseToolsPrivateEndpointResponse> GetDatabaseToolsPrivateEndpoint(GetDatabaseToolsPrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetDatabaseToolsPrivateEndpointRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetDatabaseToolsPrivateEndpointResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDatabaseToolsPrivateEndpoint API.

GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the status of the specified work request.

Declaration
public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetWorkRequestRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetWorkRequestResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetWorkRequest API.

ListDatabaseToolsConnections(ListDatabaseToolsConnectionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of Database Tools connections.

Declaration
public Task<ListDatabaseToolsConnectionsResponse> ListDatabaseToolsConnections(ListDatabaseToolsConnectionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListDatabaseToolsConnectionsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListDatabaseToolsConnectionsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDatabaseToolsConnections API.

ListDatabaseToolsEndpointServices(ListDatabaseToolsEndpointServicesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of Database Tools endpoint services.

Declaration
public Task<ListDatabaseToolsEndpointServicesResponse> ListDatabaseToolsEndpointServices(ListDatabaseToolsEndpointServicesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListDatabaseToolsEndpointServicesRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListDatabaseToolsEndpointServicesResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDatabaseToolsEndpointServices API.

ListDatabaseToolsPrivateEndpoints(ListDatabaseToolsPrivateEndpointsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of Database Tools private endpoints.

Declaration
public Task<ListDatabaseToolsPrivateEndpointsResponse> ListDatabaseToolsPrivateEndpoints(ListDatabaseToolsPrivateEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListDatabaseToolsPrivateEndpointsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListDatabaseToolsPrivateEndpointsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDatabaseToolsPrivateEndpoints API.

ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a paginated list of errors for the specified work request.

Declaration
public Task<ListWorkRequestErrorsResponse> ListWorkRequestErrors(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListWorkRequestErrorsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListWorkRequestErrorsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequestErrors API.

ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a paginated list of logs for the specified work request.

Declaration
public Task<ListWorkRequestLogsResponse> ListWorkRequestLogs(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListWorkRequestLogsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListWorkRequestLogsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequestLogs API.

ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the work requests in a compartment.

Declaration
public Task<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListWorkRequestsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListWorkRequestsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequests API.

RemoveDatabaseToolsConnectionLock(RemoveDatabaseToolsConnectionLockRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a lock from a DatabaseToolsConnection resource.

Declaration
public Task<RemoveDatabaseToolsConnectionLockResponse> RemoveDatabaseToolsConnectionLock(RemoveDatabaseToolsConnectionLockRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
RemoveDatabaseToolsConnectionLockRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<RemoveDatabaseToolsConnectionLockResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use RemoveDatabaseToolsConnectionLock API.

RemoveDatabaseToolsPrivateEndpointLock(RemoveDatabaseToolsPrivateEndpointLockRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a lock from a DatabaseToolsPrivateEndpoint resource.

Declaration
public Task<RemoveDatabaseToolsPrivateEndpointLockResponse> RemoveDatabaseToolsPrivateEndpointLock(RemoveDatabaseToolsPrivateEndpointLockRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
RemoveDatabaseToolsPrivateEndpointLockRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<RemoveDatabaseToolsPrivateEndpointLockResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use RemoveDatabaseToolsPrivateEndpointLock API.

UpdateDatabaseToolsConnection(UpdateDatabaseToolsConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified Database Tools connection.

Declaration
public Task<UpdateDatabaseToolsConnectionResponse> UpdateDatabaseToolsConnection(UpdateDatabaseToolsConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateDatabaseToolsConnectionRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<UpdateDatabaseToolsConnectionResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateDatabaseToolsConnection API.

UpdateDatabaseToolsPrivateEndpoint(UpdateDatabaseToolsPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified Database Tools private endpoint.

Declaration
public Task<UpdateDatabaseToolsPrivateEndpointResponse> UpdateDatabaseToolsPrivateEndpoint(UpdateDatabaseToolsPrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateDatabaseToolsPrivateEndpointRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<UpdateDatabaseToolsPrivateEndpointResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateDatabaseToolsPrivateEndpoint API.

ValidateDatabaseToolsConnection(ValidateDatabaseToolsConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Validates the Database Tools connection details by establishing a connection to the database.

Declaration
public Task<ValidateDatabaseToolsConnectionResponse> ValidateDatabaseToolsConnection(ValidateDatabaseToolsConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ValidateDatabaseToolsConnectionRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ValidateDatabaseToolsConnectionResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ValidateDatabaseToolsConnection API.

Implements

IDisposable
In this article
Back to top