Class CertificatesClient

Service client instance for Certificates.

Inheritance

object

ClientBase

RegionalClientBase

CertificatesClient

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

Assembly: OCI.DotNetSDK.Certificates.dll

Syntax

public class CertificatesClient : RegionalClientBase, IDisposable

Constructors

CertificatesClient(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 CertificatesClient(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.

Methods

GetCaBundle(GetCaBundleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the bundle for the specified CA bundle.

Declaration

public Task<GetCaBundleResponse> GetCaBundle(GetCaBundleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetCertificateAuthorityBundle(GetCertificateAuthorityBundleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a bundle for a certificate authority (CA) that matches either the specified stage, name, or versionNumber parameter. If none of these parameters are provided, the bundle for the CA version marked as CURRENT is returned.

Declaration

public Task<GetCertificateAuthorityBundleResponse> GetCertificateAuthorityBundle(GetCertificateAuthorityBundleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetCertificateBundle(GetCertificateBundleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a certificate bundle that matches either the specified stage, versionName, or versionNumber parameter. If none of these parameters are provided, the bundle for the certificate version marked as CURRENT is returned. <br/> By default, the private key is not included in the query result, and only the certificate bundle is returned. If you also need the private key, you can use the parameter CertificateBundleTypeQueryParam to indicate that you want a certificate bundle along with its private key as a response to your request.

Declaration

public Task<GetCertificateBundleResponse> GetCertificateBundle(GetCertificateBundleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListCertificateAuthorityBundleVersions(ListCertificateAuthorityBundleVersionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all versions of bundles for a given certificate authority (CA).

Declaration

public Task<ListCertificateAuthorityBundleVersionsResponse> ListCertificateAuthorityBundleVersions(ListCertificateAuthorityBundleVersionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListCertificateBundleVersions(ListCertificateBundleVersionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists all certificate bundle versions for the specified certificate.

Declaration

public Task<ListCertificateBundleVersionsResponse> ListCertificateBundleVersions(ListCertificateBundleVersionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable