Class ComputeManagementClient

Service client instance for ComputeManagement.

Inheritance

object

ClientBase

RegionalClientBase

ComputeManagementClient

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 ComputeManagementClient : RegionalClientBase, IDisposable

Constructors

ComputeManagementClient(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 ComputeManagementClient(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 ComputeManagementPaginators Paginators { get; }

Property Value

Type	Description
ComputeManagementPaginators

Waiters

Declaration

public ComputeManagementWaiters Waiters { get; }

Property Value

Type	Description
ComputeManagementWaiters

Methods

AttachInstancePoolInstance(AttachInstancePoolInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Attaches an instance to an instance pool. For information about the prerequisites that an instance must meet before you can attach it to a pool, see Attaching an Instance to an Instance Pool.

Declaration

public Task<AttachInstancePoolInstanceResponse> AttachInstancePoolInstance(AttachInstancePoolInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

AttachLoadBalancer(AttachLoadBalancerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Attach a load balancer to the instance pool.

Declaration

public Task<AttachLoadBalancerResponse> AttachLoadBalancer(AttachLoadBalancerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ChangeClusterNetworkCompartment(ChangeClusterNetworkCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a cluster network with instance pools 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 a cluster network to a different compartment, associated resources such as the instances in the cluster network, boot volumes, and VNICs are not moved.

Declaration

public Task<ChangeClusterNetworkCompartmentResponse> ChangeClusterNetworkCompartment(ChangeClusterNetworkCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ChangeInstanceConfigurationCompartment(ChangeInstanceConfigurationCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves an instance configuration 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 configuration to a different compartment, associated resources such as instance pools are not moved. Important: Most of the properties for an existing instance configuration, including the compartment, cannot be modified after you create the instance configuration. Although you can move an instance configuration to a different compartment, you will not be able to use the instance configuration to manage instance pools in the new compartment. If you want to update an instance configuration to point to a different compartment, you should instead create a new instance configuration in the target compartment using CreateInstanceConfiguration.

Declaration

public Task<ChangeInstanceConfigurationCompartmentResponse> ChangeInstanceConfigurationCompartment(ChangeInstanceConfigurationCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ChangeInstancePoolCompartment(ChangeInstancePoolCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves an instance pool 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 pool to a different compartment, associated resources such as the instances in the pool, boot volumes, VNICs, and autoscaling configurations are not moved.

Declaration

public Task<ChangeInstancePoolCompartmentResponse> ChangeInstancePoolCompartment(ChangeInstancePoolCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateClusterNetwork(CreateClusterNetworkRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a cluster network with instance pools. A cluster network is a group of high performance computing (HPC), GPU, or optimized bare metal instances that are connected with an ultra low-latency remote direct memory access (RDMA) network. Cluster networks with instance pools use instance pools to manage groups of identical instances. Use cluster networks with instance pools when you want predictable capacity for a specific number of identical instances that are managed as a group. If you want to manage instances in the RDMA network independently of each other or use different types of instances in the network group, create a compute cluster by using the {@link #createComputeCluster(CreateComputeClusterRequest) createComputeCluster} operation. To determine whether capacity is available for a specific shape before you create a cluster network, use the {@link #createComputeCapacityReport(CreateComputeCapacityReportRequest) createComputeCapacityReport} operation.

Declaration

public Task<CreateClusterNetworkResponse> CreateClusterNetwork(CreateClusterNetworkRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateInstanceConfiguration(CreateInstanceConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates an instance configuration. An instance configuration is a template that defines the settings to use when creating Compute instances.

Declaration

public Task<CreateInstanceConfigurationResponse> CreateInstanceConfiguration(CreateInstanceConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateInstancePool(CreateInstancePoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates an instance pool. To determine whether capacity is available for a specific shape before you create an instance pool, use the {@link #createComputeCapacityReport(CreateComputeCapacityReportRequest) createComputeCapacityReport} operation.

Declaration

public Task<CreateInstancePoolResponse> CreateInstancePool(CreateInstancePoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteInstanceConfiguration(DeleteInstanceConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes an instance configuration.

Declaration

public Task<DeleteInstanceConfigurationResponse> DeleteInstanceConfiguration(DeleteInstanceConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DetachInstancePoolInstance(DetachInstancePoolInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Detaches an instance from an instance pool.

Declaration

public Task<DetachInstancePoolInstanceResponse> DetachInstancePoolInstance(DetachInstancePoolInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DetachLoadBalancer(DetachLoadBalancerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Detach a load balancer from the instance pool.

Declaration

public Task<DetachLoadBalancerResponse> DetachLoadBalancer(DetachLoadBalancerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetClusterNetwork(GetClusterNetworkRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a cluster network with instance pools.

Declaration

public Task<GetClusterNetworkResponse> GetClusterNetwork(GetClusterNetworkRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetInstanceConfiguration(GetInstanceConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified instance configuration

Declaration

public Task<GetInstanceConfigurationResponse> GetInstanceConfiguration(GetInstanceConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetInstancePool(GetInstancePoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified instance pool

Declaration

public Task<GetInstancePoolResponse> GetInstancePool(GetInstancePoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetInstancePoolInstance(GetInstancePoolInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about an instance that belongs to an instance pool.

Declaration

public Task<GetInstancePoolInstanceResponse> GetInstancePoolInstance(GetInstancePoolInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetInstancePoolLoadBalancerAttachment(GetInstancePoolLoadBalancerAttachmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a load balancer that is attached to the specified instance pool.

Declaration

public Task<GetInstancePoolLoadBalancerAttachmentResponse> GetInstancePoolLoadBalancerAttachment(GetInstancePoolLoadBalancerAttachmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

LaunchInstanceConfiguration(LaunchInstanceConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates an instance from an instance configuration. If the instance configuration does not include all of the parameters that are required to create an instance, such as the availability domain and subnet ID, you must provide these parameters when you create an instance from the instance configuration. For more information, see the {@link InstanceConfiguration} resource. 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<LaunchInstanceConfigurationResponse> LaunchInstanceConfiguration(LaunchInstanceConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListClusterNetworkInstances(ListClusterNetworkInstancesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the instances in a cluster network with instance pools.

Declaration

public Task<ListClusterNetworkInstancesResponse> ListClusterNetworkInstances(ListClusterNetworkInstancesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListClusterNetworks(ListClusterNetworksRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the cluster networks with instance pools in the specified compartment.

Declaration

public Task<ListClusterNetworksResponse> ListClusterNetworks(ListClusterNetworksRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListInstanceConfigurations(ListInstanceConfigurationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the instance configurations in the specified compartment.

Declaration

public Task<ListInstanceConfigurationsResponse> ListInstanceConfigurations(ListInstanceConfigurationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListInstancePoolInstances(ListInstancePoolInstancesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List the instances in the specified instance pool.

Declaration

public Task<ListInstancePoolInstancesResponse> ListInstancePoolInstances(ListInstancePoolInstancesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListInstancePools(ListInstancePoolsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the instance pools in the specified compartment.

Declaration

public Task<ListInstancePoolsResponse> ListInstancePools(ListInstancePoolsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ResetInstancePool(ResetInstancePoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Performs the reset (immediate power off and power on) action on the specified instance pool, which performs the action on all the instances in the pool.

Declaration

public Task<ResetInstancePoolResponse> ResetInstancePool(ResetInstancePoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

SoftresetInstancePool(SoftresetInstancePoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Performs the softreset (ACPI shutdown and power on) action on the specified instance pool, which performs the action on all the instances in the pool. Softreset gracefully reboots the instances by sending a shutdown command to the operating systems. After waiting 15 minutes for the OS to shut down, the instances are powered off and then powered back on.

Declaration

public Task<SoftresetInstancePoolResponse> SoftresetInstancePool(SoftresetInstancePoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

SoftstopInstancePool(SoftstopInstancePoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Performs the softstop (ACPI shutdown and power on) action on the specified instance pool, which performs the action on all the instances in the pool. Softstop gracefully reboots the instances by sending a shutdown command to the operating systems. After waiting 15 minutes for the OS to shutdown, the instances are powered off and then powered back on.

Declaration

public Task<SoftstopInstancePoolResponse> SoftstopInstancePool(SoftstopInstancePoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

StartInstancePool(StartInstancePoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Performs the start (power on) action on the specified instance pool, which performs the action on all the instances in the pool.

Declaration

public Task<StartInstancePoolResponse> StartInstancePool(StartInstancePoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

StopInstancePool(StopInstancePoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Performs the stop (immediate power off) action on the specified instance pool, which performs the action on all the instances in the pool.

Declaration

public Task<StopInstancePoolResponse> StopInstancePool(StopInstancePoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

TerminateClusterNetwork(TerminateClusterNetworkRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes (terminates) a cluster network with instance pools. When you delete a cluster network, all of its resources are permanently deleted, including associated instances and instance pools.

Declaration

public Task<TerminateClusterNetworkResponse> TerminateClusterNetwork(TerminateClusterNetworkRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

TerminateInstancePool(TerminateInstancePoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Terminate the specified instance pool. Warning: When you delete an instance pool, the resources that were created by the pool are permanently deleted, including associated instances, attached boot volumes, and block volumes. If an autoscaling configuration applies to the instance pool, the autoscaling configuration will be deleted asynchronously after the pool is deleted. You can also manually delete the autoscaling configuration using the DeleteAutoScalingConfiguration operation in the Autoscaling API.

Declaration

public Task<TerminateInstancePoolResponse> TerminateInstancePool(TerminateInstancePoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateClusterNetwork(UpdateClusterNetworkRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a cluster network with instance pools. The OCID of the cluster network remains the same.

Declaration

public Task<UpdateClusterNetworkResponse> UpdateClusterNetwork(UpdateClusterNetworkRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateInstanceConfiguration(UpdateInstanceConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the free-form tags, defined tags, and display name of an instance configuration.

Declaration

public Task<UpdateInstanceConfigurationResponse> UpdateInstanceConfiguration(UpdateInstanceConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateInstancePool(UpdateInstancePoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update the specified instance pool. The OCID of the instance pool remains the same.

Declaration

public Task<UpdateInstancePoolResponse> UpdateInstancePool(UpdateInstancePoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable