Class ContainerEngineClient

Service client instance for ContainerEngine.

Inheritance

object

ClientBase

RegionalClientBase

ContainerEngineClient

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

Assembly: OCI.DotNetSDK.Containerengine.dll

Syntax

public class ContainerEngineClient : RegionalClientBase, IDisposable

Constructors

ContainerEngineClient(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 ContainerEngineClient(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 ContainerEnginePaginators Paginators { get; }

Property Value

Type	Description
ContainerEnginePaginators

Waiters

Declaration

public ContainerEngineWaiters Waiters { get; }

Property Value

Type	Description
ContainerEngineWaiters

Methods

ClusterMigrateToNativeVcn(ClusterMigrateToNativeVcnRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Initiates cluster migration to use native VCN.

Declaration

public Task<ClusterMigrateToNativeVcnResponse> ClusterMigrateToNativeVcn(ClusterMigrateToNativeVcnRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CompleteCredentialRotation(CompleteCredentialRotationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Complete cluster credential rotation. Retire old credentials from kubernetes components.

Declaration

public Task<CompleteCredentialRotationResponse> CompleteCredentialRotation(CompleteCredentialRotationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateCluster(CreateClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a new cluster.

Declaration

public Task<CreateClusterResponse> CreateCluster(CreateClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateKubeconfig(CreateKubeconfigRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create the Kubeconfig YAML for a cluster.

Declaration

public Task<CreateKubeconfigResponse> CreateKubeconfig(CreateKubeconfigRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateNodePool(CreateNodePoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a new node pool.

Declaration

public Task<CreateNodePoolResponse> CreateNodePool(CreateNodePoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateVirtualNodePool(CreateVirtualNodePoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a new virtual node pool.

Declaration

public Task<CreateVirtualNodePoolResponse> CreateVirtualNodePool(CreateVirtualNodePoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateWorkloadMapping(CreateWorkloadMappingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create the specified workloadMapping for a cluster.

Declaration

public Task<CreateWorkloadMappingResponse> CreateWorkloadMapping(CreateWorkloadMappingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteCluster(DeleteClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a cluster.

Declaration

public Task<DeleteClusterResponse> DeleteCluster(DeleteClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteNode(DeleteNodeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete node.

Declaration

public Task<DeleteNodeResponse> DeleteNode(DeleteNodeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteNodePool(DeleteNodePoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a node pool.

Declaration

public Task<DeleteNodePoolResponse> DeleteNodePool(DeleteNodePoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteVirtualNodePool(DeleteVirtualNodePoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a virtual node pool.

Declaration

public Task<DeleteVirtualNodePoolResponse> DeleteVirtualNodePool(DeleteVirtualNodePoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteWorkRequest(DeleteWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancel a work request that has not started.

Declaration

public Task<DeleteWorkRequestResponse> DeleteWorkRequest(DeleteWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteWorkloadMapping(DeleteWorkloadMappingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete workloadMapping for a provisioned cluster.

Declaration

public Task<DeleteWorkloadMappingResponse> DeleteWorkloadMapping(DeleteWorkloadMappingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DisableAddon(DisableAddonRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Disable addon for a provisioned cluster.

Declaration

public Task<DisableAddonResponse> DisableAddon(DisableAddonRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetAddon(GetAddonRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the specified addon for a cluster.

Declaration

public Task<GetAddonResponse> GetAddon(GetAddonRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetCluster(GetClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the details of a cluster.

Declaration

public Task<GetClusterResponse> GetCluster(GetClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetClusterMigrateToNativeVcnStatus(GetClusterMigrateToNativeVcnStatusRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get details on a cluster's migration to native VCN.

Declaration

public Task<GetClusterMigrateToNativeVcnStatusResponse> GetClusterMigrateToNativeVcnStatus(GetClusterMigrateToNativeVcnStatusRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetClusterOptions(GetClusterOptionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get options available for clusters.

Declaration

public Task<GetClusterOptionsResponse> GetClusterOptions(GetClusterOptionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetCredentialRotationStatus(GetCredentialRotationStatusRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get cluster credential rotation status.

Declaration

public Task<GetCredentialRotationStatusResponse> GetCredentialRotationStatus(GetCredentialRotationStatusRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetNodePool(GetNodePoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the details of a node pool.

Declaration

public Task<GetNodePoolResponse> GetNodePool(GetNodePoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetNodePoolOptions(GetNodePoolOptionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get options available for node pools.

Declaration

public Task<GetNodePoolOptionsResponse> GetNodePoolOptions(GetNodePoolOptionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetVirtualNode(GetVirtualNodeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the details of a virtual node.

Declaration

public Task<GetVirtualNodeResponse> GetVirtualNode(GetVirtualNodeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetVirtualNodePool(GetVirtualNodePoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the details of a virtual node pool.

Declaration

public Task<GetVirtualNodePoolResponse> GetVirtualNodePool(GetVirtualNodePoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the details of a work request.

Declaration

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

Parameters

Type	Name	Description
GetWorkRequestRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetWorkRequestResponse>	A response object containing details about the completed operation

Examples

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

GetWorkloadMapping(GetWorkloadMappingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the specified workloadMapping for a cluster.

Declaration

public Task<GetWorkloadMappingResponse> GetWorkloadMapping(GetWorkloadMappingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

InstallAddon(InstallAddonRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Install the specified addon for a cluster.

Declaration

public Task<InstallAddonResponse> InstallAddon(InstallAddonRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListAddonOptions(ListAddonOptionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get list of supported addons for a specific kubernetes version.

Declaration

public Task<ListAddonOptionsResponse> ListAddonOptions(ListAddonOptionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListAddons(ListAddonsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List addon for a provisioned cluster.

Declaration

public Task<ListAddonsResponse> ListAddons(ListAddonsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListClusters(ListClustersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List all the cluster objects in a compartment.

Declaration

public Task<ListClustersResponse> ListClusters(ListClustersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListNodePools(ListNodePoolsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List all the node pools in a compartment, and optionally filter by cluster.

Declaration

public Task<ListNodePoolsResponse> ListNodePools(ListNodePoolsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListPodShapes(ListPodShapesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List all the Pod Shapes in a compartment.

Declaration

public Task<ListPodShapesResponse> ListPodShapes(ListPodShapesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListVirtualNodePools(ListVirtualNodePoolsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List all the virtual node pools in a compartment, and optionally filter by cluster.

Declaration

public Task<ListVirtualNodePoolsResponse> ListVirtualNodePools(ListVirtualNodePoolsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListVirtualNodes(ListVirtualNodesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List virtual nodes in a virtual node pool.

Declaration

public Task<ListVirtualNodesResponse> ListVirtualNodes(ListVirtualNodesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the errors of a work request.

Declaration

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

Parameters

Type	Name	Description
ListWorkRequestErrorsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListWorkRequestErrorsResponse>	A response object containing details about the completed operation

Examples

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

ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the logs of a work request.

Declaration

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

Parameters

Type	Name	Description
ListWorkRequestLogsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListWorkRequestLogsResponse>	A response object containing details about the completed operation

Examples

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

ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List all work requests in a compartment.

Declaration

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

Parameters

Type	Name	Description
ListWorkRequestsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListWorkRequestsResponse>	A response object containing details about the completed operation

Examples

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

ListWorkloadMappings(ListWorkloadMappingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List workloadMappings for a provisioned cluster.

Declaration

public Task<ListWorkloadMappingsResponse> ListWorkloadMappings(ListWorkloadMappingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

RebootClusterNode(RebootClusterNodeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

perform reboot action to node in cluster

Declaration

public Task<RebootClusterNodeResponse> RebootClusterNode(RebootClusterNodeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ReplaceBootVolumeClusterNode(ReplaceBootVolumeClusterNodeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

perform cycle action to node in cluster

Declaration

public Task<ReplaceBootVolumeClusterNodeResponse> ReplaceBootVolumeClusterNode(ReplaceBootVolumeClusterNodeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

StartCredentialRotation(StartCredentialRotationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Start cluster credential rotation by adding new credentials, old credentials will still work after this operation.

Declaration

public Task<StartCredentialRotationResponse> StartCredentialRotation(StartCredentialRotationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateAddon(UpdateAddonRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update addon details for a cluster.

Declaration

public Task<UpdateAddonResponse> UpdateAddon(UpdateAddonRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateCluster(UpdateClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update the details of a cluster.

Declaration

public Task<UpdateClusterResponse> UpdateCluster(UpdateClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateClusterEndpointConfig(UpdateClusterEndpointConfigRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update the details of the cluster endpoint configuration.

Declaration

public Task<UpdateClusterEndpointConfigResponse> UpdateClusterEndpointConfig(UpdateClusterEndpointConfigRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateNodePool(UpdateNodePoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update the details of a node pool.

Declaration

public Task<UpdateNodePoolResponse> UpdateNodePool(UpdateNodePoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateVirtualNodePool(UpdateVirtualNodePoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update the details of a virtual node pool.

Declaration

public Task<UpdateVirtualNodePoolResponse> UpdateVirtualNodePool(UpdateVirtualNodePoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateWorkloadMapping(UpdateWorkloadMappingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update workloadMapping details for a cluster.

Declaration

public Task<UpdateWorkloadMappingResponse> UpdateWorkloadMapping(UpdateWorkloadMappingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable