Class ComputeClient

Service client instance for Compute.

Inheritance

object

ClientBase

RegionalClientBase

ComputeClient

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.CoreService

Assembly: OCI.DotNetSDK.Core.dll

Syntax

public class ComputeClient : RegionalClientBase, IDisposable

Constructors

ComputeClient(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 ComputeClient(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 ComputePaginators Paginators { get; }

Property Value

Type	Description
ComputePaginators

Waiters

Declaration

public ComputeWaiters Waiters { get; }

Property Value

Type	Description
ComputeWaiters

Methods

AcceptShieldedIntegrityPolicy(AcceptShieldedIntegrityPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Accept the changes to the PCR values in the measured boot report.

Declaration

public Task<AcceptShieldedIntegrityPolicyResponse> AcceptShieldedIntegrityPolicy(AcceptShieldedIntegrityPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
AcceptShieldedIntegrityPolicyRequest	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<AcceptShieldedIntegrityPolicyResponse>	A response object containing details about the completed operation

Examples

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

AddImageShapeCompatibilityEntry(AddImageShapeCompatibilityEntryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Adds a shape to the compatible shapes list for the image.

Declaration

public Task<AddImageShapeCompatibilityEntryResponse> AddImageShapeCompatibilityEntry(AddImageShapeCompatibilityEntryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
AddImageShapeCompatibilityEntryRequest	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<AddImageShapeCompatibilityEntryResponse>	A response object containing details about the completed operation

Examples

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

AttachBootVolume(AttachBootVolumeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Attaches the specified boot volume to the specified instance.

Declaration

public Task<AttachBootVolumeResponse> AttachBootVolume(AttachBootVolumeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
AttachBootVolumeRequest	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<AttachBootVolumeResponse>	A response object containing details about the completed operation

Examples

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

AttachVnic(AttachVnicRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a secondary VNIC and attaches it to the specified instance. For more information about secondary VNICs, see Virtual Network Interface Cards (VNICs).

Declaration

public Task<AttachVnicResponse> AttachVnic(AttachVnicRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
AttachVnicRequest	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<AttachVnicResponse>	A response object containing details about the completed operation

Examples

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

AttachVolume(AttachVolumeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Attaches the specified storage volume to the specified instance.

Declaration

public Task<AttachVolumeResponse> AttachVolume(AttachVolumeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
AttachVolumeRequest	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<AttachVolumeResponse>	A response object containing details about the completed operation

Examples

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

CaptureConsoleHistory(CaptureConsoleHistoryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Captures the most recent serial console data (up to a megabyte) for the specified instance. The CaptureConsoleHistory operation works with the other console history operations as described below.

Use CaptureConsoleHistory to request the capture of up to a megabyte of the most recent console history. This call returns a ConsoleHistory object. The object will have a state of REQUESTED.
Wait for the capture operation to succeed by polling GetConsoleHistory with the identifier of the console history metadata. The state of the ConsoleHistory object will go from REQUESTED to GETTING-HISTORY and then SUCCEEDED (or FAILED).
Use GetConsoleHistoryContent to get the actual console history data (not the metadata).
Optionally, use DeleteConsoleHistory to delete the console history metadata and the console history data.

Declaration

public Task<CaptureConsoleHistoryResponse> CaptureConsoleHistory(CaptureConsoleHistoryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CaptureConsoleHistoryRequest	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<CaptureConsoleHistoryResponse>	A response object containing details about the completed operation

Examples

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

ChangeComputeCapacityReservationCompartment(ChangeComputeCapacityReservationCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a compute capacity reservation into a different compartment. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration

public Task<ChangeComputeCapacityReservationCompartmentResponse> ChangeComputeCapacityReservationCompartment(ChangeComputeCapacityReservationCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeComputeCapacityReservationCompartmentRequest	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<ChangeComputeCapacityReservationCompartmentResponse>	A response object containing details about the completed operation

Examples

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

ChangeComputeCapacityTopologyCompartment(ChangeComputeCapacityTopologyCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a compute capacity topology into a different compartment. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration

public Task<ChangeComputeCapacityTopologyCompartmentResponse> ChangeComputeCapacityTopologyCompartment(ChangeComputeCapacityTopologyCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeComputeCapacityTopologyCompartmentRequest	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<ChangeComputeCapacityTopologyCompartmentResponse>	A response object containing details about the completed operation

Examples

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

ChangeComputeClusterCompartment(ChangeComputeClusterCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a compute cluster into a different compartment within the same tenancy. A compute cluster is a remote direct memory access (RDMA) network group. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration

public Task<ChangeComputeClusterCompartmentResponse> ChangeComputeClusterCompartment(ChangeComputeClusterCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeComputeClusterCompartmentRequest	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<ChangeComputeClusterCompartmentResponse>	A response object containing details about the completed operation

Examples

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

ChangeComputeImageCapabilitySchemaCompartment(ChangeComputeImageCapabilitySchemaCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a compute image capability schema into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration

public Task<ChangeComputeImageCapabilitySchemaCompartmentResponse> ChangeComputeImageCapabilitySchemaCompartment(ChangeComputeImageCapabilitySchemaCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeComputeImageCapabilitySchemaCompartmentRequest	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<ChangeComputeImageCapabilitySchemaCompartmentResponse>	A response object containing details about the completed operation

Examples

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

ChangeDedicatedVmHostCompartment(ChangeDedicatedVmHostCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a dedicated virtual machine host from one compartment to another.

Declaration

public Task<ChangeDedicatedVmHostCompartmentResponse> ChangeDedicatedVmHostCompartment(ChangeDedicatedVmHostCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeDedicatedVmHostCompartmentRequest	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<ChangeDedicatedVmHostCompartmentResponse>	A response object containing details about the completed operation

Examples

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

ChangeImageCompartment(ChangeImageCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves an image into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration

public Task<ChangeImageCompartmentResponse> ChangeImageCompartment(ChangeImageCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeImageCompartmentRequest	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<ChangeImageCompartmentResponse>	A response object containing details about the completed operation

Examples

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

ChangeInstanceCompartment(ChangeInstanceCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves an instance into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment. When you move an instance to a different compartment, associated resources such as boot volumes and VNICs are not moved.

Declaration

public Task<ChangeInstanceCompartmentResponse> ChangeInstanceCompartment(ChangeInstanceCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeInstanceCompartmentRequest	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<ChangeInstanceCompartmentResponse>	A response object containing details about the completed operation

Examples

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

CreateAppCatalogSubscription(CreateAppCatalogSubscriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a subscription for listing resource version for a compartment. It will take some time to propagate to all regions.

Declaration

public Task<CreateAppCatalogSubscriptionResponse> CreateAppCatalogSubscription(CreateAppCatalogSubscriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateAppCatalogSubscriptionRequest	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<CreateAppCatalogSubscriptionResponse>	A response object containing details about the completed operation

Examples

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

CreateComputeCapacityReport(CreateComputeCapacityReportRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Generates a report of the host capacity within an availability domain that is available for you to create compute instances. Host capacity is the physical infrastructure that resources such as compute instances run on. Use the capacity report to determine whether sufficient capacity is available for a shape before you create an instance or change the shape of an instance.

Declaration

public Task<CreateComputeCapacityReportResponse> CreateComputeCapacityReport(CreateComputeCapacityReportRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateComputeCapacityReportRequest	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<CreateComputeCapacityReportResponse>	A response object containing details about the completed operation

Examples

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

CreateComputeCapacityReservation(CreateComputeCapacityReservationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new compute capacity reservation in the specified compartment and availability domain. Compute capacity reservations let you reserve instances in a compartment. When you launch an instance using this reservation, you are assured that you have enough space for your instance, and you won't get out of capacity errors. For more information, see Reserved Capacity.

Declaration

public Task<CreateComputeCapacityReservationResponse> CreateComputeCapacityReservation(CreateComputeCapacityReservationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateComputeCapacityReservationRequest	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<CreateComputeCapacityReservationResponse>	A response object containing details about the completed operation

Examples

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

CreateComputeCapacityTopology(CreateComputeCapacityTopologyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new compute capacity topology in the specified compartment and availability domain. Compute capacity topologies provide the RDMA network topology of your bare metal hosts so that you can launch instances on your bare metal hosts with targeted network locations. Compute capacity topologies report the health status of your bare metal hosts.

Declaration

public Task<CreateComputeCapacityTopologyResponse> CreateComputeCapacityTopology(CreateComputeCapacityTopologyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateComputeCapacityTopologyRequest	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<CreateComputeCapacityTopologyResponse>	A response object containing details about the completed operation

Examples

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

CreateComputeCluster(CreateComputeClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates an empty compute cluster. A compute cluster is a remote direct memory access (RDMA) network group. After the compute cluster is created, you can use the compute cluster's OCID with the {@link #launchInstance(LaunchInstanceRequest) launchInstance} operation to create instances in the compute cluster. The instances must be created in the same compartment and availability domain as the cluster. Use compute clusters when you want to manage instances in the cluster individually in the RDMA network group. If you want predictable capacity for a specific number of identical instances that are managed as a group, create a cluster network that uses instance pools by using the {@link #createClusterNetwork(CreateClusterNetworkRequest) createClusterNetwork} operation.

Declaration

public Task<CreateComputeClusterResponse> CreateComputeCluster(CreateComputeClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateComputeClusterRequest	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<CreateComputeClusterResponse>	A response object containing details about the completed operation

Examples

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

CreateComputeImageCapabilitySchema(CreateComputeImageCapabilitySchemaRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates compute image capability schema.

Declaration

public Task<CreateComputeImageCapabilitySchemaResponse> CreateComputeImageCapabilitySchema(CreateComputeImageCapabilitySchemaRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateComputeImageCapabilitySchemaRequest	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<CreateComputeImageCapabilitySchemaResponse>	A response object containing details about the completed operation

Examples

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

CreateDedicatedVmHost(CreateDedicatedVmHostRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new dedicated virtual machine host in the specified compartment and the specified availability domain. Dedicated virtual machine hosts enable you to run your Compute virtual machine (VM) instances on dedicated servers that are a single tenant and not shared with other customers. For more information, see Dedicated Virtual Machine Hosts.

Declaration

public Task<CreateDedicatedVmHostResponse> CreateDedicatedVmHost(CreateDedicatedVmHostRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateDedicatedVmHostRequest	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<CreateDedicatedVmHostResponse>	A response object containing details about the completed operation

Examples

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

CreateImage(CreateImageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a boot disk image for the specified instance or imports an exported image from the Oracle Cloud Infrastructure Object Storage service. When creating a new image, you must provide the OCID of the instance you want to use as the basis for the image, and the OCID of the compartment containing that instance. For more information about images, see Managing Custom Images. When importing an exported image from Object Storage, you specify the source information in {@link #imageSourceDetails(ImageSourceDetailsRequest) imageSourceDetails}. When importing an image based on the namespace, bucket name, and object name, use {@link #imageSourceViaObjectStorageTupleDetails(ImageSourceViaObjectStorageTupleDetailsRequest) imageSourceViaObjectStorageTupleDetails}. When importing an image based on the Object Storage URL, use {@link #imageSourceViaObjectStorageUriDetails(ImageSourceViaObjectStorageUriDetailsRequest) imageSourceViaObjectStorageUriDetails}. See Object Storage URLs and Using Pre-Authenticated Requests for constructing URLs for image import/export. For more information about importing exported images, see Image Import/Export. You may optionally specify a display name for the image, which is simply a friendly name or description. It does not have to be unique, and you can change it. See {@link #updateImage(UpdateImageRequest) updateImage}. Avoid entering confidential information.

Declaration

public Task<CreateImageResponse> CreateImage(CreateImageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateImageRequest	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<CreateImageResponse>	A response object containing details about the completed operation

Examples

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

CreateInstanceConsoleConnection(CreateInstanceConsoleConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new console connection to the specified instance. After the console connection has been created and is available, you connect to the console using SSH. For more information about instance console connections, see Troubleshooting Instances Using Instance Console Connections.

Declaration

public Task<CreateInstanceConsoleConnectionResponse> CreateInstanceConsoleConnection(CreateInstanceConsoleConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateInstanceConsoleConnectionRequest	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<CreateInstanceConsoleConnectionResponse>	A response object containing details about the completed operation

Examples

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

DeleteAppCatalogSubscription(DeleteAppCatalogSubscriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a subscription for a listing resource version for a compartment.

Declaration

public Task<DeleteAppCatalogSubscriptionResponse> DeleteAppCatalogSubscription(DeleteAppCatalogSubscriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteAppCatalogSubscriptionRequest	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<DeleteAppCatalogSubscriptionResponse>	A response object containing details about the completed operation

Examples

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

DeleteComputeCapacityReservation(DeleteComputeCapacityReservationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified compute capacity reservation.

Declaration

public Task<DeleteComputeCapacityReservationResponse> DeleteComputeCapacityReservation(DeleteComputeCapacityReservationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteComputeCapacityReservationRequest	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<DeleteComputeCapacityReservationResponse>	A response object containing details about the completed operation

Examples

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

DeleteComputeCapacityTopology(DeleteComputeCapacityTopologyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified compute capacity topology.

Declaration

public Task<DeleteComputeCapacityTopologyResponse> DeleteComputeCapacityTopology(DeleteComputeCapacityTopologyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteComputeCapacityTopologyRequest	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<DeleteComputeCapacityTopologyResponse>	A response object containing details about the completed operation

Examples

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

DeleteComputeCluster(DeleteComputeClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a compute cluster. A compute cluster is a remote direct memory access (RDMA) network group. Before you delete a compute cluster, first delete all instances in the cluster by using the {@link #terminateInstance(TerminateInstanceRequest) terminateInstance} operation.

Declaration

public Task<DeleteComputeClusterResponse> DeleteComputeCluster(DeleteComputeClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteComputeClusterRequest	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<DeleteComputeClusterResponse>	A response object containing details about the completed operation

Examples

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

DeleteComputeImageCapabilitySchema(DeleteComputeImageCapabilitySchemaRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified Compute Image Capability Schema

Declaration

public Task<DeleteComputeImageCapabilitySchemaResponse> DeleteComputeImageCapabilitySchema(DeleteComputeImageCapabilitySchemaRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteComputeImageCapabilitySchemaRequest	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<DeleteComputeImageCapabilitySchemaResponse>	A response object containing details about the completed operation

Examples

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

DeleteConsoleHistory(DeleteConsoleHistoryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified console history metadata and the console history data.

Declaration

public Task<DeleteConsoleHistoryResponse> DeleteConsoleHistory(DeleteConsoleHistoryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteConsoleHistoryRequest	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<DeleteConsoleHistoryResponse>	A response object containing details about the completed operation

Examples

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

DeleteDedicatedVmHost(DeleteDedicatedVmHostRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified dedicated virtual machine host. If any VM instances are assigned to the dedicated virtual machine host, the delete operation will fail and the service will return a 409 response code.

Declaration

public Task<DeleteDedicatedVmHostResponse> DeleteDedicatedVmHost(DeleteDedicatedVmHostRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteDedicatedVmHostRequest	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<DeleteDedicatedVmHostResponse>	A response object containing details about the completed operation

Examples

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

DeleteImage(DeleteImageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes an image.

Declaration

public Task<DeleteImageResponse> DeleteImage(DeleteImageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteImageRequest	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<DeleteImageResponse>	A response object containing details about the completed operation

Examples

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

DeleteInstanceConsoleConnection(DeleteInstanceConsoleConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified instance console connection.

Declaration

public Task<DeleteInstanceConsoleConnectionResponse> DeleteInstanceConsoleConnection(DeleteInstanceConsoleConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteInstanceConsoleConnectionRequest	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<DeleteInstanceConsoleConnectionResponse>	A response object containing details about the completed operation

Examples

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

DetachBootVolume(DetachBootVolumeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Detaches a boot volume from an instance. You must specify the OCID of the boot volume attachment. This is an asynchronous operation. The attachment's lifecycleState will change to DETACHING temporarily until the attachment is completely removed.

Declaration

public Task<DetachBootVolumeResponse> DetachBootVolume(DetachBootVolumeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DetachBootVolumeRequest	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<DetachBootVolumeResponse>	A response object containing details about the completed operation

Examples

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

DetachVnic(DetachVnicRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Detaches and deletes the specified secondary VNIC. This operation cannot be used on the instance's primary VNIC. When you terminate an instance, all attached VNICs (primary and secondary) are automatically detached and deleted. Important: If the VNIC has a {@link PrivateIp} that is the target of a route rule, deleting the VNIC causes that route rule to blackhole and the traffic will be dropped.

Declaration

public Task<DetachVnicResponse> DetachVnic(DetachVnicRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DetachVnicRequest	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<DetachVnicResponse>	A response object containing details about the completed operation

Examples

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

DetachVolume(DetachVolumeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Detaches a storage volume from an instance. You must specify the OCID of the volume attachment. This is an asynchronous operation. The attachment's lifecycleState will change to DETACHING temporarily until the attachment is completely removed.

Declaration

public Task<DetachVolumeResponse> DetachVolume(DetachVolumeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DetachVolumeRequest	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<DetachVolumeResponse>	A response object containing details about the completed operation

Examples

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

ExportImage(ExportImageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Exports the specified image to the Oracle Cloud Infrastructure Object Storage service. You can use the Object Storage URL, or the namespace, bucket name, and object name when specifying the location to export to. For more information about exporting images, see Image Import/Export. To perform an image export, you need write access to the Object Storage bucket for the image, see Let Users Write Objects to Object Storage Buckets. See Object Storage URLs and Using Pre-Authenticated Requests for constructing URLs for image import/export.

Declaration

public Task<ExportImageResponse> ExportImage(ExportImageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ExportImageRequest	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<ExportImageResponse>	A response object containing details about the completed operation

Examples

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

GetAppCatalogListing(GetAppCatalogListingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified listing.

Declaration

public Task<GetAppCatalogListingResponse> GetAppCatalogListing(GetAppCatalogListingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetAppCatalogListingRequest	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<GetAppCatalogListingResponse>	A response object containing details about the completed operation

Examples

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

GetAppCatalogListingAgreements(GetAppCatalogListingAgreementsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves the agreements for a particular resource version of a listing.

Declaration

public Task<GetAppCatalogListingAgreementsResponse> GetAppCatalogListingAgreements(GetAppCatalogListingAgreementsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetAppCatalogListingAgreementsRequest	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<GetAppCatalogListingAgreementsResponse>	A response object containing details about the completed operation

Examples

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

GetAppCatalogListingResourceVersion(GetAppCatalogListingResourceVersionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified listing resource version.

Declaration

public Task<GetAppCatalogListingResourceVersionResponse> GetAppCatalogListingResourceVersion(GetAppCatalogListingResourceVersionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetAppCatalogListingResourceVersionRequest	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<GetAppCatalogListingResourceVersionResponse>	A response object containing details about the completed operation

Examples

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

GetBootVolumeAttachment(GetBootVolumeAttachmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about the specified boot volume attachment.

Declaration

public Task<GetBootVolumeAttachmentResponse> GetBootVolumeAttachment(GetBootVolumeAttachmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetBootVolumeAttachmentRequest	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<GetBootVolumeAttachmentResponse>	A response object containing details about the completed operation

Examples

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

GetComputeCapacityReservation(GetComputeCapacityReservationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about the specified compute capacity reservation.

Declaration

public Task<GetComputeCapacityReservationResponse> GetComputeCapacityReservation(GetComputeCapacityReservationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetComputeCapacityReservationRequest	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<GetComputeCapacityReservationResponse>	A response object containing details about the completed operation

Examples

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

GetComputeCapacityTopology(GetComputeCapacityTopologyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about the specified compute capacity topology.

Declaration

public Task<GetComputeCapacityTopologyResponse> GetComputeCapacityTopology(GetComputeCapacityTopologyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetComputeCapacityTopologyRequest	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<GetComputeCapacityTopologyResponse>	A response object containing details about the completed operation

Examples

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

GetComputeCluster(GetComputeClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a compute cluster. A compute cluster is a remote direct memory access (RDMA) network group.

Declaration

public Task<GetComputeClusterResponse> GetComputeCluster(GetComputeClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetComputeClusterRequest	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<GetComputeClusterResponse>	A response object containing details about the completed operation

Examples

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

GetComputeGlobalImageCapabilitySchema(GetComputeGlobalImageCapabilitySchemaRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified Compute Global Image Capability Schema

Declaration

public Task<GetComputeGlobalImageCapabilitySchemaResponse> GetComputeGlobalImageCapabilitySchema(GetComputeGlobalImageCapabilitySchemaRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetComputeGlobalImageCapabilitySchemaRequest	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<GetComputeGlobalImageCapabilitySchemaResponse>	A response object containing details about the completed operation

Examples

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

GetComputeGlobalImageCapabilitySchemaVersion(GetComputeGlobalImageCapabilitySchemaVersionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified Compute Global Image Capability Schema Version

Declaration

public Task<GetComputeGlobalImageCapabilitySchemaVersionResponse> GetComputeGlobalImageCapabilitySchemaVersion(GetComputeGlobalImageCapabilitySchemaVersionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetComputeGlobalImageCapabilitySchemaVersionRequest	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<GetComputeGlobalImageCapabilitySchemaVersionResponse>	A response object containing details about the completed operation

Examples

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

GetComputeImageCapabilitySchema(GetComputeImageCapabilitySchemaRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified Compute Image Capability Schema

Declaration

public Task<GetComputeImageCapabilitySchemaResponse> GetComputeImageCapabilitySchema(GetComputeImageCapabilitySchemaRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetComputeImageCapabilitySchemaRequest	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<GetComputeImageCapabilitySchemaResponse>	A response object containing details about the completed operation

Examples

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

GetConsoleHistory(GetConsoleHistoryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Shows the metadata for the specified console history. See {@link #captureConsoleHistory(CaptureConsoleHistoryRequest) captureConsoleHistory} for details about using the console history operations.

Declaration

public Task<GetConsoleHistoryResponse> GetConsoleHistory(GetConsoleHistoryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetConsoleHistoryRequest	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<GetConsoleHistoryResponse>	A response object containing details about the completed operation

Examples

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

GetConsoleHistoryContent(GetConsoleHistoryContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the actual console history data (not the metadata). See {@link #captureConsoleHistory(CaptureConsoleHistoryRequest) captureConsoleHistory} for details about using the console history operations.

Declaration

public Task<GetConsoleHistoryContentResponse> GetConsoleHistoryContent(GetConsoleHistoryContentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetConsoleHistoryContentRequest	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<GetConsoleHistoryContentResponse>	A response object containing details about the completed operation

Examples

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

GetDedicatedVmHost(GetDedicatedVmHostRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about the specified dedicated virtual machine host.

Declaration

public Task<GetDedicatedVmHostResponse> GetDedicatedVmHost(GetDedicatedVmHostRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDedicatedVmHostRequest	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<GetDedicatedVmHostResponse>	A response object containing details about the completed operation

Examples

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

GetImage(GetImageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified image.

Declaration

public Task<GetImageResponse> GetImage(GetImageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetImageRequest	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<GetImageResponse>	A response object containing details about the completed operation

Examples

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

GetImageShapeCompatibilityEntry(GetImageShapeCompatibilityEntryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves an image shape compatibility entry.

Declaration

public Task<GetImageShapeCompatibilityEntryResponse> GetImageShapeCompatibilityEntry(GetImageShapeCompatibilityEntryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetImageShapeCompatibilityEntryRequest	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<GetImageShapeCompatibilityEntryResponse>	A response object containing details about the completed operation

Examples

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

GetInstance(GetInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about the specified instance. Note: To retrieve public and private IP addresses for an instance, use the {@link #listVnicAttachments(ListVnicAttachmentsRequest) listVnicAttachments} operation to get the VNIC ID for the instance, and then call {@link #getVnic(GetVnicRequest) getVnic} with the VNIC ID.

Declaration

public Task<GetInstanceResponse> GetInstance(GetInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetInstanceRequest	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<GetInstanceResponse>	A response object containing details about the completed operation

Examples

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

GetInstanceConsoleConnection(GetInstanceConsoleConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified instance console connection's information.

Declaration

public Task<GetInstanceConsoleConnectionResponse> GetInstanceConsoleConnection(GetInstanceConsoleConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetInstanceConsoleConnectionRequest	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<GetInstanceConsoleConnectionResponse>	A response object containing details about the completed operation

Examples

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

GetInstanceMaintenanceEvent(GetInstanceMaintenanceEventRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the maintenance event for the given instance.

Declaration

public Task<GetInstanceMaintenanceEventResponse> GetInstanceMaintenanceEvent(GetInstanceMaintenanceEventRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetInstanceMaintenanceEventRequest	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<GetInstanceMaintenanceEventResponse>	A response object containing details about the completed operation

Examples

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

GetInstanceMaintenanceReboot(GetInstanceMaintenanceRebootRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the maximum possible date that a maintenance reboot can be extended. For more information, see Infrastructure Maintenance.

Declaration

public Task<GetInstanceMaintenanceRebootResponse> GetInstanceMaintenanceReboot(GetInstanceMaintenanceRebootRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetInstanceMaintenanceRebootRequest	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<GetInstanceMaintenanceRebootResponse>	A response object containing details about the completed operation

Examples

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

GetMeasuredBootReport(GetMeasuredBootReportRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the measured boot report for this shielded instance.

Declaration

public Task<GetMeasuredBootReportResponse> GetMeasuredBootReport(GetMeasuredBootReportRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetMeasuredBootReportRequest	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<GetMeasuredBootReportResponse>	A response object containing details about the completed operation

Examples

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

GetVnicAttachment(GetVnicAttachmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the information for the specified VNIC attachment.

Declaration

public Task<GetVnicAttachmentResponse> GetVnicAttachment(GetVnicAttachmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetVnicAttachmentRequest	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<GetVnicAttachmentResponse>	A response object containing details about the completed operation

Examples

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

GetVolumeAttachment(GetVolumeAttachmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about the specified volume attachment.

Declaration

public Task<GetVolumeAttachmentResponse> GetVolumeAttachment(GetVolumeAttachmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetVolumeAttachmentRequest	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<GetVolumeAttachmentResponse>	A response object containing details about the completed operation

Examples

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

GetWindowsInstanceInitialCredentials(GetWindowsInstanceInitialCredentialsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the generated credentials for the instance. Only works for instances that require a password to log in, such as Windows. For certain operating systems, users will be forced to change the initial credentials.

Declaration

public Task<GetWindowsInstanceInitialCredentialsResponse> GetWindowsInstanceInitialCredentials(GetWindowsInstanceInitialCredentialsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetWindowsInstanceInitialCredentialsRequest	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<GetWindowsInstanceInitialCredentialsResponse>	A response object containing details about the completed operation

Examples

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

InstanceAction(InstanceActionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Performs one of the following power actions on the specified instance:

START - Powers on the instance.
STOP - Powers off the instance.
RESET - Powers off the instance and then powers it back on.
SOFTSTOP - Gracefully shuts down the instance by sending a shutdown command to the operating system. After waiting 15 minutes for the OS to shut down, the instance is powered off. If the applications that run on the instance take more than 15 minutes to shut down, they could be improperly stopped, resulting in data corruption. To avoid this, manually shut down the instance using the commands available in the OS before you softstop the instance.
SOFTRESET - Gracefully reboots the instance by sending a shutdown command to the operating system. After waiting 15 minutes for the OS to shut down, the instance is powered off and then powered back on.
SENDDIAGNOSTICINTERRUPT - For advanced users. Caution: Sending a diagnostic interrupt to a live system can cause data corruption or system failure. Sends a diagnostic interrupt that causes the instance's OS to crash and then reboot. Before you send a diagnostic interrupt, you must configure the instance to generate a crash dump file when it crashes. The crash dump captures information about the state of the OS at the time of the crash. After the OS restarts, you can analyze the crash dump to diagnose the issue. For more information, see Sending a Diagnostic Interrupt.

DIAGNOSTICREBOOT - Powers off the instance, rebuilds it, and then powers it back on. Before you send a diagnostic reboot, restart the instance's OS, confirm that the instance and networking settings are configured correctly, and try other troubleshooting steps. Use diagnostic reboot as a final attempt to troubleshoot an unreachable instance. For virtual machine (VM) instances only. For more information, see Performing a Diagnostic Reboot.
REBOOTMIGRATE - Powers off the instance, moves it to new hardware, and then powers it back on. For more information, see Infrastructure Maintenance.

For more information about managing instance lifecycle states, see Stopping and Starting an Instance.

Declaration

public Task<InstanceActionResponse> InstanceAction(InstanceActionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
InstanceActionRequest	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<InstanceActionResponse>	A response object containing details about the completed operation

Examples

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

LaunchInstance(LaunchInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new instance in the specified compartment and the specified availability domain. For general information about instances, see Overview of the Compute Service. For information about access control and compartments, see Overview of the IAM Service. For information about availability domains, see Regions and Availability Domains. To get a list of availability domains, use the ListAvailabilityDomains operation in the Identity and Access Management Service API. All Oracle Cloud Infrastructure resources, including instances, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console. To launch an instance using an image or a boot volume use the sourceDetails parameter in {@link LaunchInstanceDetails}. When you launch an instance, it is automatically attached to a virtual network interface card (VNIC), called the primary VNIC. The VNIC has a private IP address from the subnet's CIDR. You can either assign a private IP address of your choice or let Oracle automatically assign one. You can choose whether the instance has a public IP address. To retrieve the addresses, use the {@link #listVnicAttachments(ListVnicAttachmentsRequest) listVnicAttachments} operation to get the VNIC ID for the instance, and then call {@link #getVnic(GetVnicRequest) getVnic} with the VNIC ID. You can later add secondary VNICs to an instance. For more information, see Virtual Network Interface Cards (VNICs). To launch an instance from a Marketplace image listing, you must provide the image ID of the listing resource version that you want, but you also must subscribe to the listing before you try to launch the instance. To subscribe to the listing, use the {@link #getAppCatalogListingAgreements(GetAppCatalogListingAgreementsRequest) getAppCatalogListingAgreements} operation to get the signature for the terms of use agreement for the desired listing resource version. Then, call {@link #createAppCatalogSubscription(CreateAppCatalogSubscriptionRequest) createAppCatalogSubscription} with the signature. To get the image ID for the LaunchInstance operation, call {@link #getAppCatalogListingResourceVersion(GetAppCatalogListingResourceVersionRequest) getAppCatalogListingResourceVersion}. When launching an instance, you may provide the securityAttributes parameter in {@link LaunchInstanceDetails} to manage security attributes via the instance, or in the embedded {@link CreateVnicDetails} to manage security attributes via the VNIC directly, but not both. Providing securityAttributes in both locations will return a 400 Bad Request response. To determine whether capacity is available for a specific shape before you create an instance, use the {@link #createComputeCapacityReport(CreateComputeCapacityReportRequest) createComputeCapacityReport} operation.

Declaration

public Task<LaunchInstanceResponse> LaunchInstance(LaunchInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
LaunchInstanceRequest	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<LaunchInstanceResponse>	A response object containing details about the completed operation

Examples

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

ListAppCatalogListingResourceVersions(ListAppCatalogListingResourceVersionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets all resource versions for a particular listing.

Declaration

public Task<ListAppCatalogListingResourceVersionsResponse> ListAppCatalogListingResourceVersions(ListAppCatalogListingResourceVersionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAppCatalogListingResourceVersionsRequest	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<ListAppCatalogListingResourceVersionsResponse>	A response object containing details about the completed operation

Examples

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

ListAppCatalogListings(ListAppCatalogListingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the published listings.

Declaration

public Task<ListAppCatalogListingsResponse> ListAppCatalogListings(ListAppCatalogListingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAppCatalogListingsRequest	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<ListAppCatalogListingsResponse>	A response object containing details about the completed operation

Examples

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

ListAppCatalogSubscriptions(ListAppCatalogSubscriptionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists subscriptions for a compartment.

Declaration

public Task<ListAppCatalogSubscriptionsResponse> ListAppCatalogSubscriptions(ListAppCatalogSubscriptionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAppCatalogSubscriptionsRequest	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<ListAppCatalogSubscriptionsResponse>	A response object containing details about the completed operation

Examples

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

ListBootVolumeAttachments(ListBootVolumeAttachmentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the boot volume attachments in the specified compartment. You can filter the list by specifying an instance OCID, boot volume OCID, or both.

Declaration

public Task<ListBootVolumeAttachmentsResponse> ListBootVolumeAttachments(ListBootVolumeAttachmentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListBootVolumeAttachmentsRequest	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<ListBootVolumeAttachmentsResponse>	A response object containing details about the completed operation

Examples

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

ListComputeCapacityReservationInstanceShapes(ListComputeCapacityReservationInstanceShapesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the shapes that can be reserved within the specified compartment.

Declaration

public Task<ListComputeCapacityReservationInstanceShapesResponse> ListComputeCapacityReservationInstanceShapes(ListComputeCapacityReservationInstanceShapesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListComputeCapacityReservationInstanceShapesRequest	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<ListComputeCapacityReservationInstanceShapesResponse>	A response object containing details about the completed operation

Examples

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

ListComputeCapacityReservationInstances(ListComputeCapacityReservationInstancesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the instances launched under a capacity reservation. You can filter results by specifying criteria.

Declaration

public Task<ListComputeCapacityReservationInstancesResponse> ListComputeCapacityReservationInstances(ListComputeCapacityReservationInstancesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListComputeCapacityReservationInstancesRequest	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<ListComputeCapacityReservationInstancesResponse>	A response object containing details about the completed operation

Examples

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

ListComputeCapacityReservations(ListComputeCapacityReservationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the compute capacity reservations that match the specified criteria and compartment. You can limit the list by specifying a compute capacity reservation display name (the list will include all the identically-named compute capacity reservations in the compartment).

Declaration

public Task<ListComputeCapacityReservationsResponse> ListComputeCapacityReservations(ListComputeCapacityReservationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListComputeCapacityReservationsRequest	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<ListComputeCapacityReservationsResponse>	A response object containing details about the completed operation

Examples

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

ListComputeCapacityTopologies(ListComputeCapacityTopologiesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the compute capacity topologies in the specified compartment. You can filter the list by a compute capacity topology display name.

Declaration

public Task<ListComputeCapacityTopologiesResponse> ListComputeCapacityTopologies(ListComputeCapacityTopologiesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListComputeCapacityTopologiesRequest	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<ListComputeCapacityTopologiesResponse>	A response object containing details about the completed operation

Examples

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

ListComputeCapacityTopologyComputeBareMetalHosts(ListComputeCapacityTopologyComputeBareMetalHostsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists compute bare metal hosts in the specified compute capacity topology.

Declaration

public Task<ListComputeCapacityTopologyComputeBareMetalHostsResponse> ListComputeCapacityTopologyComputeBareMetalHosts(ListComputeCapacityTopologyComputeBareMetalHostsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListComputeCapacityTopologyComputeBareMetalHostsRequest	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<ListComputeCapacityTopologyComputeBareMetalHostsResponse>	A response object containing details about the completed operation

Examples

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

ListComputeCapacityTopologyComputeHpcIslands(ListComputeCapacityTopologyComputeHpcIslandsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists compute HPC islands in the specified compute capacity topology.

Declaration

public Task<ListComputeCapacityTopologyComputeHpcIslandsResponse> ListComputeCapacityTopologyComputeHpcIslands(ListComputeCapacityTopologyComputeHpcIslandsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListComputeCapacityTopologyComputeHpcIslandsRequest	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<ListComputeCapacityTopologyComputeHpcIslandsResponse>	A response object containing details about the completed operation

Examples

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

ListComputeCapacityTopologyComputeNetworkBlocks(ListComputeCapacityTopologyComputeNetworkBlocksRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists compute network blocks in the specified compute capacity topology.

Declaration

public Task<ListComputeCapacityTopologyComputeNetworkBlocksResponse> ListComputeCapacityTopologyComputeNetworkBlocks(ListComputeCapacityTopologyComputeNetworkBlocksRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListComputeCapacityTopologyComputeNetworkBlocksRequest	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<ListComputeCapacityTopologyComputeNetworkBlocksResponse>	A response object containing details about the completed operation

Examples

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

ListComputeClusters(ListComputeClustersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the compute clusters in the specified compartment. A compute cluster is a remote direct memory access (RDMA) network group.

Declaration

public Task<ListComputeClustersResponse> ListComputeClusters(ListComputeClustersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListComputeClustersRequest	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<ListComputeClustersResponse>	A response object containing details about the completed operation

Examples

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

ListComputeGlobalImageCapabilitySchemaVersions(ListComputeGlobalImageCapabilitySchemaVersionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists Compute Global Image Capability Schema versions in the specified compartment.

Declaration

public Task<ListComputeGlobalImageCapabilitySchemaVersionsResponse> ListComputeGlobalImageCapabilitySchemaVersions(ListComputeGlobalImageCapabilitySchemaVersionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListComputeGlobalImageCapabilitySchemaVersionsRequest	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<ListComputeGlobalImageCapabilitySchemaVersionsResponse>	A response object containing details about the completed operation

Examples

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

ListComputeGlobalImageCapabilitySchemas(ListComputeGlobalImageCapabilitySchemasRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists Compute Global Image Capability Schema in the specified compartment.

Declaration

public Task<ListComputeGlobalImageCapabilitySchemasResponse> ListComputeGlobalImageCapabilitySchemas(ListComputeGlobalImageCapabilitySchemasRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListComputeGlobalImageCapabilitySchemasRequest	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<ListComputeGlobalImageCapabilitySchemasResponse>	A response object containing details about the completed operation

Examples

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

ListComputeImageCapabilitySchemas(ListComputeImageCapabilitySchemasRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists Compute Image Capability Schema in the specified compartment. You can also query by a specific imageId.

Declaration

public Task<ListComputeImageCapabilitySchemasResponse> ListComputeImageCapabilitySchemas(ListComputeImageCapabilitySchemasRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListComputeImageCapabilitySchemasRequest	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<ListComputeImageCapabilitySchemasResponse>	A response object containing details about the completed operation

Examples

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

ListConsoleHistories(ListConsoleHistoriesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the console history metadata for the specified compartment or instance.

Declaration

public Task<ListConsoleHistoriesResponse> ListConsoleHistories(ListConsoleHistoriesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListConsoleHistoriesRequest	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<ListConsoleHistoriesResponse>	A response object containing details about the completed operation

Examples

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

ListDedicatedVmHostInstanceShapes(ListDedicatedVmHostInstanceShapesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the shapes that can be used to launch a virtual machine instance on a dedicated virtual machine host within the specified compartment. You can filter the list by compatibility with a specific dedicated virtual machine host shape.

Declaration

public Task<ListDedicatedVmHostInstanceShapesResponse> ListDedicatedVmHostInstanceShapes(ListDedicatedVmHostInstanceShapesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDedicatedVmHostInstanceShapesRequest	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<ListDedicatedVmHostInstanceShapesResponse>	A response object containing details about the completed operation

Examples

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

ListDedicatedVmHostInstances(ListDedicatedVmHostInstancesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the list of instances on the dedicated virtual machine hosts that match the specified criteria.

Declaration

public Task<ListDedicatedVmHostInstancesResponse> ListDedicatedVmHostInstances(ListDedicatedVmHostInstancesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDedicatedVmHostInstancesRequest	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<ListDedicatedVmHostInstancesResponse>	A response object containing details about the completed operation

Examples

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

ListDedicatedVmHostShapes(ListDedicatedVmHostShapesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the shapes that can be used to launch a dedicated virtual machine host within the specified compartment.

Declaration

public Task<ListDedicatedVmHostShapesResponse> ListDedicatedVmHostShapes(ListDedicatedVmHostShapesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDedicatedVmHostShapesRequest	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<ListDedicatedVmHostShapesResponse>	A response object containing details about the completed operation

Examples

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

ListDedicatedVmHosts(ListDedicatedVmHostsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the list of dedicated virtual machine hosts that match the specified criteria in the specified compartment. You can limit the list by specifying a dedicated virtual machine host display name. The list will include all the identically-named dedicated virtual machine hosts in the compartment.

Declaration

public Task<ListDedicatedVmHostsResponse> ListDedicatedVmHosts(ListDedicatedVmHostsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDedicatedVmHostsRequest	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<ListDedicatedVmHostsResponse>	A response object containing details about the completed operation

Examples

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

ListImageShapeCompatibilityEntries(ListImageShapeCompatibilityEntriesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the compatible shapes for the specified image.

Declaration

public Task<ListImageShapeCompatibilityEntriesResponse> ListImageShapeCompatibilityEntries(ListImageShapeCompatibilityEntriesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListImageShapeCompatibilityEntriesRequest	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<ListImageShapeCompatibilityEntriesResponse>	A response object containing details about the completed operation

Examples

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

ListImages(ListImagesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists a subset of images available in the specified compartment, including platform images and custom images. The list of platform images includes the three most recently published versions of each major distribution. The list does not support filtering based on image tags. The list of images returned is ordered to first show the recent platform images, then all of the custom images. Caution: Platform images are refreshed regularly. When new images are released, older versions are replaced. The image OCIDs remain available, but when the platform image is replaced, the image OCIDs are no longer returned as part of the platform image list.

Declaration

public Task<ListImagesResponse> ListImages(ListImagesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListImagesRequest	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<ListImagesResponse>	A response object containing details about the completed operation

Examples

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

ListInstanceConsoleConnections(ListInstanceConsoleConnectionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the console connections for the specified compartment or instance. For more information about instance console connections, see Troubleshooting Instances Using Instance Console Connections.

Declaration

public Task<ListInstanceConsoleConnectionsResponse> ListInstanceConsoleConnections(ListInstanceConsoleConnectionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListInstanceConsoleConnectionsRequest	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<ListInstanceConsoleConnectionsResponse>	A response object containing details about the completed operation

Examples

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

ListInstanceDevices(ListInstanceDevicesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of all the devices for given instance. You can optionally filter results by device availability.

Declaration

public Task<ListInstanceDevicesResponse> ListInstanceDevices(ListInstanceDevicesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListInstanceDevicesRequest	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<ListInstanceDevicesResponse>	A response object containing details about the completed operation

Examples

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

ListInstanceMaintenanceEvents(ListInstanceMaintenanceEventsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of all the maintenance events for the given instance.

Declaration

public Task<ListInstanceMaintenanceEventsResponse> ListInstanceMaintenanceEvents(ListInstanceMaintenanceEventsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListInstanceMaintenanceEventsRequest	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<ListInstanceMaintenanceEventsResponse>	A response object containing details about the completed operation

Examples

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

ListInstances(ListInstancesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the instances in the specified compartment and the specified availability domain. You can filter the results by specifying an instance name (the list will include all the identically-named instances in the compartment). Note: To retrieve public and private IP addresses for an instance, use the {@link #listVnicAttachments(ListVnicAttachmentsRequest) listVnicAttachments} operation to get the VNIC ID for the instance, and then call {@link #getVnic(GetVnicRequest) getVnic} with the VNIC ID.

Declaration

public Task<ListInstancesResponse> ListInstances(ListInstancesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListInstancesRequest	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<ListInstancesResponse>	A response object containing details about the completed operation

Examples

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

ListShapes(ListShapesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the shapes that can be used to launch an instance within the specified compartment. You can filter the list by compatibility with a specific image.

Declaration

public Task<ListShapesResponse> ListShapes(ListShapesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListShapesRequest	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<ListShapesResponse>	A response object containing details about the completed operation

Examples

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

ListVnicAttachments(ListVnicAttachmentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the VNIC attachments in the specified compartment. A VNIC attachment resides in the same compartment as the attached instance. The list can be filtered by instance, VNIC, or availability domain.

Declaration

public Task<ListVnicAttachmentsResponse> ListVnicAttachments(ListVnicAttachmentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListVnicAttachmentsRequest	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<ListVnicAttachmentsResponse>	A response object containing details about the completed operation

Examples

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

ListVolumeAttachments(ListVolumeAttachmentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the volume attachments in the specified compartment. You can filter the list by specifying an instance OCID, volume OCID, or both. Currently, the only supported volume attachment type are {@link IScsiVolumeAttachment} and {@link ParavirtualizedVolumeAttachment}.

Declaration

public Task<ListVolumeAttachmentsResponse> ListVolumeAttachments(ListVolumeAttachmentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListVolumeAttachmentsRequest	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<ListVolumeAttachmentsResponse>	A response object containing details about the completed operation

Examples

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

RemoveImageShapeCompatibilityEntry(RemoveImageShapeCompatibilityEntryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a shape from the compatible shapes list for the image.

Declaration

public Task<RemoveImageShapeCompatibilityEntryResponse> RemoveImageShapeCompatibilityEntry(RemoveImageShapeCompatibilityEntryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RemoveImageShapeCompatibilityEntryRequest	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<RemoveImageShapeCompatibilityEntryResponse>	A response object containing details about the completed operation

Examples

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

TerminateInstance(TerminateInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Permanently terminates (deletes) the specified instance. Any attached VNICs and volumes are automatically detached when the instance terminates. To preserve the boot volume associated with the instance, specify true for PreserveBootVolumeQueryParam. To delete the boot volume when the instance is deleted, specify false or do not specify a value for PreserveBootVolumeQueryParam. To preserve data volumes created with the instance, specify true or do not specify a value for PreserveDataVolumesQueryParam. To delete the data volumes when the instance itself is deleted, specify false for PreserveDataVolumesQueryParam. This is an asynchronous operation. The instance's lifecycleState changes to TERMINATING temporarily until the instance is completely deleted. After the instance is deleted, the record remains visible in the list of instances with the state TERMINATED for at least 12 hours, but no further action is needed.

Declaration

public Task<TerminateInstanceResponse> TerminateInstance(TerminateInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
TerminateInstanceRequest	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<TerminateInstanceResponse>	A response object containing details about the completed operation

Examples

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

UpdateComputeCapacityReservation(UpdateComputeCapacityReservationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified capacity reservation and its associated capacity configurations. Fields that are not provided in the request will not be updated. Capacity configurations that are not included will be deleted. Avoid entering confidential information.

Declaration

public Task<UpdateComputeCapacityReservationResponse> UpdateComputeCapacityReservation(UpdateComputeCapacityReservationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateComputeCapacityReservationRequest	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<UpdateComputeCapacityReservationResponse>	A response object containing details about the completed operation

Examples

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

UpdateComputeCapacityTopology(UpdateComputeCapacityTopologyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified compute capacity topology. Fields that are not provided in the request will not be updated.

Declaration

public Task<UpdateComputeCapacityTopologyResponse> UpdateComputeCapacityTopology(UpdateComputeCapacityTopologyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateComputeCapacityTopologyRequest	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<UpdateComputeCapacityTopologyResponse>	A response object containing details about the completed operation

Examples

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

UpdateComputeCluster(UpdateComputeClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a compute cluster. A compute cluster is a remote direct memory access (RDMA) network group. To create instances within a compute cluster, use the {@link #launchInstance(LaunchInstanceRequest) launchInstance} operation. To delete instances from a compute cluster, use the {@link #terminateInstance(TerminateInstanceRequest) terminateInstance} operation.

Declaration

public Task<UpdateComputeClusterResponse> UpdateComputeCluster(UpdateComputeClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateComputeClusterRequest	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<UpdateComputeClusterResponse>	A response object containing details about the completed operation

Examples

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

UpdateComputeImageCapabilitySchema(UpdateComputeImageCapabilitySchemaRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified Compute Image Capability Schema

Declaration

public Task<UpdateComputeImageCapabilitySchemaResponse> UpdateComputeImageCapabilitySchema(UpdateComputeImageCapabilitySchemaRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateComputeImageCapabilitySchemaRequest	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<UpdateComputeImageCapabilitySchemaResponse>	A response object containing details about the completed operation

Examples

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

UpdateConsoleHistory(UpdateConsoleHistoryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified console history metadata.

Declaration

public Task<UpdateConsoleHistoryResponse> UpdateConsoleHistory(UpdateConsoleHistoryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateConsoleHistoryRequest	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<UpdateConsoleHistoryResponse>	A response object containing details about the completed operation

Examples

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

UpdateDedicatedVmHost(UpdateDedicatedVmHostRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the displayName, freeformTags, and definedTags attributes for the specified dedicated virtual machine host. If an attribute value is not included, it will not be updated.

Declaration

public Task<UpdateDedicatedVmHostResponse> UpdateDedicatedVmHost(UpdateDedicatedVmHostRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateDedicatedVmHostRequest	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<UpdateDedicatedVmHostResponse>	A response object containing details about the completed operation

Examples

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

UpdateImage(UpdateImageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the display name of the image. Avoid entering confidential information.

Declaration

public Task<UpdateImageResponse> UpdateImage(UpdateImageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateImageRequest	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<UpdateImageResponse>	A response object containing details about the completed operation

Examples

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

UpdateInstance(UpdateInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates certain fields on the specified instance. Fields that are not provided in the request will not be updated. Avoid entering confidential information. Changes to metadata fields will be reflected in the instance metadata service (this may take up to a minute). The OCID of the instance remains the same.

Declaration

public Task<UpdateInstanceResponse> UpdateInstance(UpdateInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateInstanceRequest	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<UpdateInstanceResponse>	A response object containing details about the completed operation

Examples

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

UpdateInstanceConsoleConnection(UpdateInstanceConsoleConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the defined tags and free-form tags for the specified instance console connection.

Declaration

public Task<UpdateInstanceConsoleConnectionResponse> UpdateInstanceConsoleConnection(UpdateInstanceConsoleConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateInstanceConsoleConnectionRequest	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<UpdateInstanceConsoleConnectionResponse>	A response object containing details about the completed operation

Examples

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

UpdateInstanceMaintenanceEvent(UpdateInstanceMaintenanceEventRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the maintenance event for the given instance.

Declaration

public Task<UpdateInstanceMaintenanceEventResponse> UpdateInstanceMaintenanceEvent(UpdateInstanceMaintenanceEventRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateInstanceMaintenanceEventRequest	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<UpdateInstanceMaintenanceEventResponse>	A response object containing details about the completed operation

Examples

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

UpdateVolumeAttachment(UpdateVolumeAttachmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates information about the specified volume attachment.

Declaration

public Task<UpdateVolumeAttachmentResponse> UpdateVolumeAttachment(UpdateVolumeAttachmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateVolumeAttachmentRequest	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<UpdateVolumeAttachmentResponse>	A response object containing details about the completed operation

Examples

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

Implements

IDisposable