Class EkmClient

Service client instance for Ekm.

Inheritance

object

ClientBase

RegionalClientBase

EkmClient

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

Assembly: OCI.DotNetSDK.Keymanagement.dll

Syntax

public class EkmClient : RegionalClientBase, IDisposable

Constructors

EkmClient(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 EkmClient(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 EkmPaginators Paginators { get; }

Property Value

Type	Description
EkmPaginators

Waiters

Declaration

public EkmWaiters Waiters { get; }

Property Value

Type	Description
EkmWaiters

Methods

CreateEkmsPrivateEndpoint(CreateEkmsPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a new EKMS private endpoint used to connect to external key manager system

Declaration

public Task<CreateEkmsPrivateEndpointResponse> CreateEkmsPrivateEndpoint(CreateEkmsPrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteEkmsPrivateEndpoint(DeleteEkmsPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes EKMS private endpoint by identifier.

Declaration

public Task<DeleteEkmsPrivateEndpointResponse> DeleteEkmsPrivateEndpoint(DeleteEkmsPrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetEkmsPrivateEndpoint(GetEkmsPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a specific EKMS private by identifier.

Declaration

public Task<GetEkmsPrivateEndpointResponse> GetEkmsPrivateEndpoint(GetEkmsPrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListEkmsPrivateEndpoints(ListEkmsPrivateEndpointsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of all the EKMS private endpoints in the specified compartment.

Declaration

public Task<ListEkmsPrivateEndpointsResponse> ListEkmsPrivateEndpoints(ListEkmsPrivateEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateEkmsPrivateEndpoint(UpdateEkmsPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates EKMS private endpoint.

Declaration

public Task<UpdateEkmsPrivateEndpointResponse> UpdateEkmsPrivateEndpoint(UpdateEkmsPrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable