Show / Hide Table of Contents

Class BaseinfraClient

Service client instance for Baseinfra.

Inheritance
object
ClientBase
RegionalClientBase
BaseinfraClient
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)
ClientBase.EnableDualStackEndpoints(bool)
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.DataccService
Assembly: OCI.DotNetSDK.Datacc.dll
Syntax
public class BaseinfraClient : RegionalClientBase, IDisposable

Constructors

BaseinfraClient(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 BaseinfraClient(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 BaseinfraPaginators Paginators { get; }
Property Value
Type Description
BaseinfraPaginators

Waiters

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

Methods

ActivateInfrastructure(ActivateInfrastructureRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Activate an Database Infrastructure using the specified details.

Declaration
public Task<ActivateInfrastructureResponse> ActivateInfrastructure(ActivateInfrastructureRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ActivateInfrastructureRequest 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<ActivateInfrastructureResponse>

A response object containing details about the completed operation

Examples

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

ChangeInfrastructureCompartment(ChangeInfrastructureCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Change the Database Infrastructure Cloud@Customer Compartment to the specified OCID.

Declaration
public Task<ChangeInfrastructureCompartmentResponse> ChangeInfrastructureCompartment(ChangeInfrastructureCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeInfrastructureCompartmentRequest 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<ChangeInfrastructureCompartmentResponse>

A response object containing details about the completed operation

Examples

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

ChangeVmClusterNetworkCompartment(ChangeVmClusterNetworkCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Change the VM cluster network Compartment to the specified OCID.

Declaration
public Task<ChangeVmClusterNetworkCompartmentResponse> ChangeVmClusterNetworkCompartment(ChangeVmClusterNetworkCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeVmClusterNetworkCompartmentRequest 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<ChangeVmClusterNetworkCompartmentResponse>

A response object containing details about the completed operation

Examples

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

ChangeVmInstanceCompartment(ChangeVmInstanceCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Change the VM instance on Database Infrastructure Compartment to the specified OCID.

Declaration
public Task<ChangeVmInstanceCompartmentResponse> ChangeVmInstanceCompartment(ChangeVmInstanceCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeVmInstanceCompartmentRequest 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<ChangeVmInstanceCompartmentResponse>

A response object containing details about the completed operation

Examples

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

CreateInfrastructure(CreateInfrastructureRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a Database Infrastructure using the specified details.

Declaration
public Task<CreateInfrastructureResponse> CreateInfrastructure(CreateInfrastructureRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateInfrastructureRequest 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<CreateInfrastructureResponse>

A response object containing details about the completed operation

Examples

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

CreateVmClusterNetwork(CreateVmClusterNetworkRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create an VM cluster on Database Infrastructure network using the specified details.

Declaration
public Task<CreateVmClusterNetworkResponse> CreateVmClusterNetwork(CreateVmClusterNetworkRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateVmClusterNetworkRequest 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<CreateVmClusterNetworkResponse>

A response object containing details about the completed operation

Examples

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

CreateVmInstance(CreateVmInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create an VM instance on Database Infrastructure using the specified details.

Declaration
public Task<CreateVmInstanceResponse> CreateVmInstance(CreateVmInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateVmInstanceRequest 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<CreateVmInstanceResponse>

A response object containing details about the completed operation

Examples

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

DeleteInfrastructure(DeleteInfrastructureRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete the Database Infrastructure that has the specified OCID. It must be called once the resource usage is complete.

Declaration
public Task<DeleteInfrastructureResponse> DeleteInfrastructure(DeleteInfrastructureRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteInfrastructureRequest 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<DeleteInfrastructureResponse>

A response object containing details about the completed operation

Examples

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

DeleteVmClusterNetwork(DeleteVmClusterNetworkRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete the VM cluster network on Database Infrastructure that has the specified OCID. It must be called once the resource usage is complete.

Declaration
public Task<DeleteVmClusterNetworkResponse> DeleteVmClusterNetwork(DeleteVmClusterNetworkRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteVmClusterNetworkRequest 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<DeleteVmClusterNetworkResponse>

A response object containing details about the completed operation

Examples

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

DeleteVmInstance(DeleteVmInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete the VM instance on Database Infrastructure that has the specified OCID. It must be called once the resource usage is complete.

Declaration
public Task<DeleteVmInstanceResponse> DeleteVmInstance(DeleteVmInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteVmInstanceRequest 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<DeleteVmInstanceResponse>

A response object containing details about the completed operation

Examples

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

DownloadInfrastructureConfigFile(DownloadInfrastructureConfigFileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Downloads the configuration file for the specified Database Infrastructure Cloud@Customer.

Declaration
public Task<DownloadInfrastructureConfigFileResponse> DownloadInfrastructureConfigFile(DownloadInfrastructureConfigFileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DownloadInfrastructureConfigFileRequest 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<DownloadInfrastructureConfigFileResponse>

A response object containing details about the completed operation

Examples

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

DownloadInfrastructureValidationScript(DownloadInfrastructureValidationScriptRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Downloads the validation script for the specified Database Infrastructure Cloud@Customer.

Declaration
public Task<DownloadInfrastructureValidationScriptResponse> DownloadInfrastructureValidationScript(DownloadInfrastructureValidationScriptRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DownloadInfrastructureValidationScriptRequest 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<DownloadInfrastructureValidationScriptResponse>

A response object containing details about the completed operation

Examples

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

GenerateRecommendedVmClusterNetwork(GenerateRecommendedVmClusterNetworkRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Generates an VM cluster network configuration using the specified details.

Declaration
public Task<GenerateRecommendedVmClusterNetworkResponse> GenerateRecommendedVmClusterNetwork(GenerateRecommendedVmClusterNetworkRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GenerateRecommendedVmClusterNetworkRequest 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<GenerateRecommendedVmClusterNetworkResponse>

A response object containing details about the completed operation

Examples

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

GetInfrastructure(GetInfrastructureRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Obtain the Database Infrastructure that has the specified OCID.

Declaration
public Task<GetInfrastructureResponse> GetInfrastructure(GetInfrastructureRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetInfrastructureRequest 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<GetInfrastructureResponse>

A response object containing details about the completed operation

Examples

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

GetInfrastructureScaleOption(GetInfrastructureScaleOptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the available scale options for the infrastructure that has the specified OCID.

Declaration
public Task<GetInfrastructureScaleOptionResponse> GetInfrastructureScaleOption(GetInfrastructureScaleOptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetInfrastructureScaleOptionRequest 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<GetInfrastructureScaleOptionResponse>

A response object containing details about the completed operation

Examples

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

GetMaintenanceExecution(GetMaintenanceExecutionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about the specified OCID.

Declaration
public Task<GetMaintenanceExecutionResponse> GetMaintenanceExecution(GetMaintenanceExecutionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetMaintenanceExecutionRequest 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<GetMaintenanceExecutionResponse>

A response object containing details about the completed operation

Examples

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

GetMaintenanceRun(GetMaintenanceRunRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about the specified OCID.

Declaration
public Task<GetMaintenanceRunResponse> GetMaintenanceRun(GetMaintenanceRunRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetMaintenanceRunRequest 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<GetMaintenanceRunResponse>

A response object containing details about the completed operation

Examples

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

GetVmClusterNetwork(GetVmClusterNetworkRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Obtain the VM cluster network on Database Infrastructure that has the specified OCID.

Declaration
public Task<GetVmClusterNetworkResponse> GetVmClusterNetwork(GetVmClusterNetworkRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetVmClusterNetworkRequest 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<GetVmClusterNetworkResponse>

A response object containing details about the completed operation

Examples

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

GetVmInstance(GetVmInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Obtain the VM instance on Database Infrastructure that has the specified OCID.

Declaration
public Task<GetVmInstanceResponse> GetVmInstance(GetVmInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetVmInstanceRequest 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<GetVmInstanceResponse>

A response object containing details about the completed operation

Examples

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

GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the status of the work request having the specified work request OCID.

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.

ListInfrastructures(ListInfrastructuresRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Obtain a list of Database Infrastructures.

Declaration
public Task<ListInfrastructuresResponse> ListInfrastructures(ListInfrastructuresRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListInfrastructuresRequest 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<ListInfrastructuresResponse>

A response object containing details about the completed operation

Examples

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

ListMaintenanceExecutions(ListMaintenanceExecutionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of the maintenance executions in the specified compartment.

Declaration
public Task<ListMaintenanceExecutionsResponse> ListMaintenanceExecutions(ListMaintenanceExecutionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListMaintenanceExecutionsRequest 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<ListMaintenanceExecutionsResponse>

A response object containing details about the completed operation

Examples

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

ListMaintenanceRuns(ListMaintenanceRunsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of the maintenance runs in the specified compartment.

Declaration
public Task<ListMaintenanceRunsResponse> ListMaintenanceRuns(ListMaintenanceRunsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListMaintenanceRunsRequest 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<ListMaintenanceRunsResponse>

A response object containing details about the completed operation

Examples

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

ListVmClusterNetworks(ListVmClusterNetworksRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Obtain a list of VM cluster networks on Database Infrastructure.

Declaration
public Task<ListVmClusterNetworksResponse> ListVmClusterNetworks(ListVmClusterNetworksRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListVmClusterNetworksRequest 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<ListVmClusterNetworksResponse>

A response object containing details about the completed operation

Examples

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

ListVmInstances(ListVmInstancesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Obtain a list of VM instances.

Declaration
public Task<ListVmInstancesResponse> ListVmInstances(ListVmInstancesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListVmInstancesRequest 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<ListVmInstancesResponse>

A response object containing details about the completed operation

Examples

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

ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

View the list of errors for the work request that have the specified work request OCID.

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)

View the log entries for the work request that have the specified work request OCID.

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)

View a list of work request details in the specified 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.

MigrateVmInstance(MigrateVmInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Migrate the VM instance on Database Infrastructure that has the specified OCID.

Declaration
public Task<MigrateVmInstanceResponse> MigrateVmInstance(MigrateVmInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
MigrateVmInstanceRequest 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<MigrateVmInstanceResponse>

A response object containing details about the completed operation

Examples

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

RescheduleMaintenanceRun(RescheduleMaintenanceRunRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Reschedules the specified maintenance run by providing a new timeScheduled value. Only maintenance runs in eligible states may be rescheduled.

Declaration
public Task<RescheduleMaintenanceRunResponse> RescheduleMaintenanceRun(RescheduleMaintenanceRunRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
RescheduleMaintenanceRunRequest 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<RescheduleMaintenanceRunResponse>

A response object containing details about the completed operation

Examples

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

RestartVmInstance(RestartVmInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Restart the VM instance on Database Infrastructure that has the specified OCID.

Declaration
public Task<RestartVmInstanceResponse> RestartVmInstance(RestartVmInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
RestartVmInstanceRequest 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<RestartVmInstanceResponse>

A response object containing details about the completed operation

Examples

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

ScaleInfrastructureStorage(ScaleInfrastructureStorageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Scale storage for the specified infrastructure using the specified details.

Declaration
public Task<ScaleInfrastructureStorageResponse> ScaleInfrastructureStorage(ScaleInfrastructureStorageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ScaleInfrastructureStorageRequest 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<ScaleInfrastructureStorageResponse>

A response object containing details about the completed operation

Examples

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

ScaleVmInstance(ScaleVmInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Scale the VM instance on Database Infrastructure that has the specified OCID.

Declaration
public Task<ScaleVmInstanceResponse> ScaleVmInstance(ScaleVmInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ScaleVmInstanceRequest 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<ScaleVmInstanceResponse>

A response object containing details about the completed operation

Examples

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

StartVmInstance(StartVmInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Start the VM instance on Database Infrastructure that has the specified OCID.

Declaration
public Task<StartVmInstanceResponse> StartVmInstance(StartVmInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
StartVmInstanceRequest 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<StartVmInstanceResponse>

A response object containing details about the completed operation

Examples

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

StopVmInstance(StopVmInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Stop the VM instance on Database Infrastructure that has the specified OCID.

Declaration
public Task<StopVmInstanceResponse> StopVmInstance(StopVmInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
StopVmInstanceRequest 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<StopVmInstanceResponse>

A response object containing details about the completed operation

Examples

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

UpdateInfrastructure(UpdateInfrastructureRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update the Database Infrastructure that has the specified OCID.

Declaration
public Task<UpdateInfrastructureResponse> UpdateInfrastructure(UpdateInfrastructureRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateInfrastructureRequest 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<UpdateInfrastructureResponse>

A response object containing details about the completed operation

Examples

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

UpdateMaintenanceRun(UpdateMaintenanceRunRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update maintenance run attributes.

Declaration
public Task<UpdateMaintenanceRunResponse> UpdateMaintenanceRun(UpdateMaintenanceRunRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateMaintenanceRunRequest 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<UpdateMaintenanceRunResponse>

A response object containing details about the completed operation

Examples

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

UpdateVmClusterNetwork(UpdateVmClusterNetworkRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update the VM cluster network on Database Infrastructure that has the specified OCID.

Declaration
public Task<UpdateVmClusterNetworkResponse> UpdateVmClusterNetwork(UpdateVmClusterNetworkRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateVmClusterNetworkRequest 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<UpdateVmClusterNetworkResponse>

A response object containing details about the completed operation

Examples

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

UpdateVmInstance(UpdateVmInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update the VM instance on Database Infrastructure that has the specified OCID.

Declaration
public Task<UpdateVmInstanceResponse> UpdateVmInstance(UpdateVmInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateVmInstanceRequest 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<UpdateVmInstanceResponse>

A response object containing details about the completed operation

Examples

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

ValidateInfrastructure(ValidateInfrastructureRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Validate an Database Infrastructure using the specified details.

Declaration
public Task<ValidateInfrastructureResponse> ValidateInfrastructure(ValidateInfrastructureRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ValidateInfrastructureRequest 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<ValidateInfrastructureResponse>

A response object containing details about the completed operation

Examples

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

ValidateVmClusterNetwork(ValidateVmClusterNetworkRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Validates an VM cluster network on Database Infrastructure.

Declaration
public Task<ValidateVmClusterNetworkResponse> ValidateVmClusterNetwork(ValidateVmClusterNetworkRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ValidateVmClusterNetworkRequest 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<ValidateVmClusterNetworkResponse>

A response object containing details about the completed operation

Examples

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

Implements

IDisposable
In this article
Back to top