Class KmsHsmClusterClient

Service client instance for KmsHsmCluster.

Inheritance

object

ClientBase

RegionalClientBase

KmsHsmClusterClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

ClientBase.EnableDualStackEndpoints(bool)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.KeymanagementService

Assembly: OCI.DotNetSDK.Keymanagement.dll

Syntax

public class KmsHsmClusterClient : RegionalClientBase, IDisposable

Constructors

KmsHsmClusterClient(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 KmsHsmClusterClient(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 KmsHsmClusterPaginators Paginators { get; }

Property Value

Type	Description
KmsHsmClusterPaginators

Waiters

Declaration

public KmsHsmClusterWaiters Waiters { get; }

Property Value

Type	Description
KmsHsmClusterWaiters

Methods

CancelHsmClusterDeletion(CancelHsmClusterDeletionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancels deletion of specified HSM Cluster, restores it and associated HSM partitions to pre-deletion states.

Declaration

public Task<CancelHsmClusterDeletionResponse> CancelHsmClusterDeletion(CancelHsmClusterDeletionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ChangeHsmClusterCompartment(ChangeHsmClusterCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a HSM Cluster resource to a different compartment within the same tenancy.

Declaration

public Task<ChangeHsmClusterCompartmentResponse> ChangeHsmClusterCompartment(ChangeHsmClusterCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateHsmCluster(CreateHsmClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new HSM cluster resource.

Declaration

public Task<CreateHsmClusterResponse> CreateHsmCluster(CreateHsmClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DisableAuditMgmtLogging(DisableAuditMgmtLoggingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Disables management audit logging for the given HSM Cluster resource. This requires the Crypto Officer (CO) password. This operation is idempotent: if audit logging is already disabled, the call is a no-op and returns success.

Declaration

public Task<DisableAuditMgmtLoggingResponse> DisableAuditMgmtLogging(DisableAuditMgmtLoggingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DownloadCertificateSigningRequest(DownloadCertificateSigningRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves the certificate signing request for the designated HSM Cluster resource.

Declaration

public Task<DownloadCertificateSigningRequestResponse> DownloadCertificateSigningRequest(DownloadCertificateSigningRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

EnableAuditMgmtLogging(EnableAuditMgmtLoggingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Validates that the Dynamic Group and bucket policy supplied during EnableAuditLogging / CreateHsmCluster are now in place. If the cluster is in WAITING_FOR_CUSTOMER, and validation is successful, status is progressed and a work request is started. If the cluster has already progressed past that gate, the call is idempotent and returns 202 with the current cluster representation.

Declaration

public Task<EnableAuditMgmtLoggingResponse> EnableAuditMgmtLogging(EnableAuditMgmtLoggingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetHsmCluster(GetHsmClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves configuration details for the specified HSM Cluster resource. <br/> As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning read operations exceeds 10 requests per second for a given tenancy.

Declaration

public Task<GetHsmClusterResponse> GetHsmCluster(GetHsmClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetHsmPartition(GetHsmPartitionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves HSM partition details for the specified HSM cluster.

Declaration

public Task<GetHsmPartitionResponse> GetHsmPartition(GetHsmPartitionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetPreCoUserCredentials(GetPreCoUserCredentialsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves Pre Crypto Officer user credentials for the specified HSM cluster.

Declaration

public Task<GetPreCoUserCredentialsResponse> GetPreCoUserCredentials(GetPreCoUserCredentialsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

InitiateAuditLogging(InitiateAuditLoggingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Initiates the process of enabling audit logs for a HSM cluster resource by taking in the required parameters.

Declaration

public Task<InitiateAuditLoggingResponse> InitiateAuditLogging(InitiateAuditLoggingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListHsmClusters(ListHsmClustersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all HSM cluster resources contained within the specified compartment. <br/> As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning read operations exceeds 10 requests per second for a given tenancy.

Declaration

public Task<ListHsmClustersResponse> ListHsmClusters(ListHsmClustersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListHsmPartitions(ListHsmPartitionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all HSM partitions within the specified HSM Cluster resource.

Declaration

public Task<ListHsmPartitionsResponse> ListHsmPartitions(ListHsmPartitionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ScheduleHsmClusterDeletion(ScheduleHsmClusterDeletionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Schedules HSM cluster for deletion, update its lifecycle state to 'PENDING_DELETION' and deletes it after the retention period.

Declaration

public Task<ScheduleHsmClusterDeletionResponse> ScheduleHsmClusterDeletion(ScheduleHsmClusterDeletionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateAuditLoggingDestination(UpdateAuditLoggingDestinationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

update bucket details of management audit logs for a HSM cluster resource by hsmClusterId.

Declaration

public Task<UpdateAuditLoggingDestinationResponse> UpdateAuditLoggingDestination(UpdateAuditLoggingDestinationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateHsmCluster(UpdateHsmClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Modifies properties of an HSM cluster resource, including displayName, freeformTags and definedTags. <br/> As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.

Declaration

public Task<UpdateHsmClusterResponse> UpdateHsmCluster(UpdateHsmClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UploadPartitionCertificates(UploadPartitionCertificatesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Uploads the partition owner certificates to the HSM Cluster resource.

Declaration

public Task<UploadPartitionCertificatesResponse> UploadPartitionCertificates(UploadPartitionCertificatesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable